@owdproject/core 3.0.0-alpha.9 → 3.1.1

package/README.md

@@ -1,148 +1,124 @@
 <p align="center">
-  <img width="160" height="160" alt="Open Web Desktop logo" src="https://avatars.githubusercontent.com/u/65117737?s=160&v=4" />
+  <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 framework for building web-based desktop experiences.
+  A modular framework for building web-based desktop experiences.
 </h3>
 
 ## Overview
-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.
 
-[Check out the demo](https://owdproject.github.io/docs) of the `client` base repository, decked with a couple of modules.
+Open Web Desktop (OWD) is a framework designed to provide a simple environment for building web-based desktop experiences. It's built with Vue.js & TypeScript, and it leverages the extensible Nuxt.js architecture.
+
+[Demo](https://atproto-os.pages.dev/) · [Documentation](https://owdproject.org/)
 
 ## Features
+
 - Open-source web desktop environment built with Nuxt.js
 - Fully extendable through themes, apps, and modules
-- Bundled with popular libraries like Pinia, VueUse, Mitt
+- 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 i18n support
+- Fully localizable with nuxt-i18n support
 
 ## Getting started
-Required software:
 
-- [Git](https://git-scm.com)
-- [Node](https://nodejs.org)
+Bootstrap a new project by running:
 
-When you are ready, bootstrap a new project by running:
 ```bash
 npm create owd
 ```
-Once the process is complete, you can start to develop:
-```bash
-# Run the dev server with hot-reload
-npm run dev
 
-# Build for production
-npm run generate
-```
+Once the process is done, you can start to develop:
 
-## Modules
-Open Web Desktop projects can be extended with themes, plugins, and desktop apps.
+```bash
+cd owd-client
 
-### Install a new app
-You can simply install a new application and define it this way.
+# Run the dev server with hot-reload
+pnpm install
+pnpm run dev
 
-```typescript
-// owd.config.ts
-export default defineDesktopConfig({
-    apps: [
-        "@owdproject/app-about",
-        "@owdproject/app-todo",
-    ]
-})
+# Build for production
+pnpm run generate
 ```
 
-## Themes
-Themes allow you to customize the look and feel of your Open Web Desktop instance.
-You can explore available themes, ranging from popular OS designs to fully custom creations, at [topics/owd-themes](https://github.com/topics/owd-themes).
+## Extend your desktop
 
-### Install a new theme
-You can install a new theme by defining it in the `owd.config.ts` configuration.  
-Themes can be loaded from a local path or directly from a GitHub repository.
+Open Web Desktop can be extended with themes, modules and applications.
 
-#### Using a local theme
+### Install an application
 
-Clone it first in a folder of your project like `./desktop/theme/theme-gnome`.
+You can install a new [application](https://github.com/topics/owd-apps) with:
 
 ```bash
-git clone git@github.com:owdproject/theme-gnome.git ./desktop/theme/theme-gnome
+pnpm install @owdproject/app-todo
 ```
 
-Then specify the path theme in `owd.config.ts`:
+Then, define it in the desktop configuration:
 
 ```typescript
-// owd.config.ts
+// desktop/owd.config.ts
 export default defineDesktopConfig({
-    theme: './dev/themes/theme-gnome', // define here the theme you just cloned
+    theme: "@owdproject/theme-win95",
     apps: [
-    ...
+        "@owdproject/app-about",
+        "@owdproject/app-todo", // define here the app you just installed
+    ],
+    modules: []
+})
 ```
 
-#### Using a theme package
+### Install a module
 
-Use npm to install the theme package as a dependency of your Open Web Desktop client:
+You can install a new [module](https://github.com/topics/owd-modules) with:
 
 ```bash
-npm install @owdproject/theme-gnome
+pnpm install @owdproject/module-pinia-localforage
 ```
 
-Then specify the path theme in `owd.config.ts`:
+Then, define it in the desktop configuration:
 
 ```typescript
-// owd.config.ts
-import {defineDesktopConfig} from "@owdproject/core/runtime/utils/utilDesktop"
-
+// desktop/owd.config.ts
 export default defineDesktopConfig({
-    theme: '@owdproject/theme-gnome', // define here the theme you just installed
+    theme: "@owdproject/theme-win95",
     apps: [
-        ...
+        "@owdproject/app-about",
+        "@owdproject/app-todo",
+    ],
+    modules: [
+        "@owdproject/module-pinia-localforage", // define here the module you just installed
+    ]
+})
 ```
 
-## Contributing
-
-**Any contribution is welcome!** Open Web Desktop is built with Nuxt and follows a modular architecture, making it easy to contribute to the core codebase or create new modules.
-
-### Local Development Setup
-
-If you'd like to contribute, here's how to set up your local development environment:
-
-**Prerequisites:**
-
-- [Git](https://git-scm.com)
-- [Node](https://nodejs.org)
-
-**Cloning the Repository:**
-
-To contribute, start by forking the Open Web Desktop client repository on GitHub.  
-Then, clone your fork using HTTPS or SSH:
+## Themes
+You can install a new [theme](https://github.com/topics/owd-themes) in the same way.
 
 ```bash
-# Clone using HTTPS
-git clone https://github.com/<your-username>/client.git
-
-# Clone using SSH
-git clone git@github.com:<your-username>/client.git
+pnpm install @owdproject/theme-gnome
 ```
 
-Once you have cloned the repository, navigate to the project folder.  
-Install the dependencies, then start the development server:
+Define the theme in `owd.config.ts`:
 
-```bash
-cd owd-client
-
-npm install
-npm run dev
+```typescript
+// desktop/owd.config.ts
+export default defineDesktopConfig({
+    theme: "@owdproject/theme-gnome", // define here the theme you just installed
+    apps: [
+        "@owdproject/app-about",
+        "@owdproject/app-todo",
+    ],
+    modules: [
+        "@owdproject/module-pinia-localforage"
+    ]
+})
 ```
 
-This will launch Open Web Desktop in development mode, allowing you to test your changes and see them reflected in real-time.
-The dev server will be available at http://localhost:3000.
-
-## Sponsoring
+## Sponsors
 
-Open Web Desktop is a vast project. The code has been totally rewritten and is now actively being developed, but your support is what makes it all possible. If you're enjoying it and want to see more, consider donating. Your contribution helps keep the project alive and awesome.
+Make this project sustainable, your support is crucial to keep it moving forward.
 
 ## License
 
-Open Web Desktop is released under the [GNU General Public License v3](LICENSE).
+Open Web Desktop is released under the [MIT License](LICENSE).

package/eslint.config.mjs

@@ -0,0 +1,30 @@
+import { FlatCompat } from '@eslint/eslintrc';
+import { dirname } from 'path';
+import { fileURLToPath } from 'url';
+import js from '@eslint/js';
+import baseConfig from '../../eslint.config.mjs';
+const compat = new FlatCompat({
+  baseDirectory: dirname(fileURLToPath(import.meta.url)),
+  recommendedConfig: js.configs.recommended,
+});
+
+export default [
+  ...baseConfig,
+  {
+    files: ['**/*.ts', '**/*.tsx', '**/*.js', '**/*.jsx', '**/*.vue'],
+    // Override or add rules here
+    rules: {},
+  },
+  //...compat.extends('@nuxt/eslint-config'),
+  {
+    files: ['**/*.vue'],
+    languageOptions: {
+      parserOptions: {
+        parser: await import('@typescript-eslint/parser'),
+      },
+    },
+  },
+  {
+    ignores: ['.nuxt/**', '.output/**', 'node_modules'],
+  },
+];

package/index.ts

@@ -1,192 +1,2 @@
-import {defineNuxtModule, createResolver, addComponentsDir, addImportsDir, installModule, addPlugin} from '@nuxt/kit'
-import {deepMerge} from '@owdproject/core/runtime/utils/utilCommon'
-import pkg from './package.json'
-
-export default defineNuxtModule({
-    meta: {
-        name: 'owd-core',
-        priority: 9999,
-    },
-    async setup(options, nuxt) {
-        const {resolve} = createResolver(import.meta.url)
-
-        const desktopConfig = (await import(nuxt.options.rootDir + '/owd.config.ts')).default
-
-        // set core version to runtime config
-
-        nuxt.options.runtimeConfig.public.coreVersion = pkg.version
-
-        {
-
-            // install open web desktop theme
-
-            if (desktopConfig.theme) {
-                await installModule(desktopConfig.theme)
-            }
-
-            // install open web desktop modules
-
-            if (desktopConfig.modules) {
-                for (const modulePath of desktopConfig.modules) {
-                    await installModule(modulePath)
-                }
-            }
-
-            // install open web desktop apps
-
-            if (desktopConfig.apps) {
-                for (const appPath of desktopConfig.apps) {
-                    await installModule(appPath)
-                }
-            }
-
-            // assign open web desktop config to runtime config
-            nuxt.options.runtimeConfig.public.desktop = deepMerge(
-                nuxt.options.runtimeConfig.public.desktop,
-                desktopConfig
-            )
-
-        }
-
-        {
-
-            // install primevue
-
-            nuxt.options.primevue = nuxt.options.primevue || {};
-            nuxt.options.primevue.options = nuxt.options.primevue.options || {};
-            nuxt.options.primevue.options.theme = nuxt.options.primevue.options.theme || {};
-
-            await installModule("@primevue/nuxt-module")
-
-        }
-
-        {
-
-            // install tailwind
-
-            const tailwindPaths = nuxt.options.runtimeConfig?.owd?.tailwindPaths || []
-            tailwindPaths.push('./runtime/components/**/*.{vue,mjs,ts}')  // Aggiungi sempre questo al core
-
-            nuxt.options.tailwindcss = nuxt.options.tailwindcss || {}
-            nuxt.options.tailwindcss.config = nuxt.options.tailwindcss.config || {}
-            // @ts-ignore
-            nuxt.options.tailwindcss.config.content = tailwindPaths
-
-            await installModule('@nuxtjs/tailwindcss', {
-                viewer: false,
-            })
-
-        }
-
-        {
-
-            // install pinia
-
-            await installModule("@pinia/nuxt")
-
-        }
-
-        {
-
-            // install @nuxt/fonts
-
-            await installModule("@nuxt/fonts")
-
-        }
-
-        {
-
-            // install @nuxt/icon
-
-            await installModule("@nuxt/icon", {
-                clientBundle: {
-                    scan: true,
-                    sizeLimitKb: 256,
-                },
-            })
-
-        }
-
-        {
-
-            // install @vueuse/nuxt
-
-            await installModule("@vueuse/nuxt")
-
-        }
-
-        {
-
-            // install @nuxtjs/i18n
-
-            await installModule("@nuxtjs/i18n")
-
-        }
-
-        {
-
-            // 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',
-                }
-            })
-
-        }
-
-        {
-
-            // add css
-
-            nuxt.options.css.push('sanitize.css')
-
-        }
-
-        {
-
-            // add components
-
-            addComponentsDir({
-                path: resolve("./runtime/components"),
-                prefix: "",
-                global: true,
-            })
-
-        }
-
-        {
-
-            // install plugins
-
-            addPlugin(resolve('./runtime/plugins/resize.client.ts'))
-
-            // add other files
-
-            addImportsDir(resolve('./runtime/composables'))
-            addImportsDir(resolve('./runtime/core'))
-            addImportsDir(resolve('./runtime/stores'))
-            addImportsDir(resolve('./runtime/utils'))
-
-        }
-    }
-})
-
-export * from './runtime/composables/useAppEntries'
-export * from './runtime/composables/useApplicationManager'
-export * from './runtime/composables/useDesktopManager'
-export * from './runtime/composables/useTerminalManager'
-export * from './runtime/utils/utilApp'
-export * from './runtime/utils/utilCommon'
-export * from './runtime/utils/utilDebug'
-export * from './runtime/utils/utilDesktop'
-export * from './runtime/utils/utilTerminal'
-export * from './runtime/utils/utilWindow'
-export * from './runtime/stores/storeApplicationMeta'
-export * from './runtime/stores/storeApplicationWindows'
-export * from './runtime/stores/storeDesktop'
-export * from './runtime/stores/storeDesktopVolume'
-export * from './runtime/stores/storeDesktopWindow'
-export * from './runtime/stores/storeDesktopWorkspace'
+export { defineDesktopApp, defineDesktopConfig } from "./runtime/utils/utilDesktop"
+export { registerTailwindPath } from "./runtime/utils/utilApp"

package/module.ts

@@ -0,0 +1,181 @@
+import {defineNuxtModule, createResolver, addComponentsDir, addImportsDir, installModule, addPlugin} from '@nuxt/kit'
+import {deepMerge} from './runtime/utils/utilCommon'
+import pkg from './package.json'
+
+export default defineNuxtModule({
+  meta: {
+    name: 'owd-core',
+  },
+  async setup(_options, _nuxt) {
+    const {resolve} = createResolver(import.meta.url)
+
+    // get open web desktop config
+
+    const desktopConfig = (await import(_nuxt.options.rootDir + '/owd.config.ts')).default
+
+    // extend nuxt.config.ts with owd.config.ts
+
+    _nuxt.options = {
+      ..._nuxt.options,
+      ...desktopConfig,
+    }
+
+    // set core version to runtime config
+
+    _nuxt.options.runtimeConfig.public.coreVersion = pkg.version
+
+    {
+
+      // install open web desktop theme
+
+      if (desktopConfig.theme) {
+        await installModule(desktopConfig.theme)
+      }
+
+      // install open web desktop modules
+
+      if (desktopConfig.modules) {
+        for (const modulePath of desktopConfig.modules) {
+          await installModule(modulePath)
+        }
+      }
+
+      // install open web desktop apps
+
+      if (desktopConfig.apps) {
+        for (const appPath of desktopConfig.apps) {
+          await installModule(appPath)
+        }
+      }
+
+      // assign open web desktop config to runtime config
+      _nuxt.options.runtimeConfig.public.desktop = deepMerge(
+        _nuxt.options.runtimeConfig.public.desktop,
+        desktopConfig
+      )
+
+    }
+
+    {
+
+      // install primevue
+
+      _nuxt.options.primevue = _nuxt.options.primevue || {};
+      _nuxt.options.primevue.options = _nuxt.options.primevue.options || {};
+      _nuxt.options.primevue.options.theme = _nuxt.options.primevue.options.theme || {};
+
+      await installModule("@primevue/nuxt-module")
+
+    }
+
+    {
+
+      // install tailwind
+
+      const tailwindPaths = _nuxt.options.runtimeConfig.app.owd?.tailwindPaths || []
+      tailwindPaths.push('./runtime/components/**/*.{vue,mjs,ts}')  // Aggiungi sempre questo al core
+
+      _nuxt.options.tailwindcss = _nuxt.options.tailwindcss || {}
+      _nuxt.options.tailwindcss.config = _nuxt.options.tailwindcss.config || {}
+      // @ts-ignore
+      _nuxt.options.tailwindcss.config.content = tailwindPaths
+
+      await installModule('@nuxtjs/tailwindcss', {
+        viewer: false,
+      })
+
+    }
+
+    {
+
+      // install pinia
+
+      await installModule("@pinia/nuxt")
+
+    }
+
+    {
+
+      // install @nuxt/fonts
+
+      await installModule("@nuxt/fonts")
+
+    }
+
+    {
+
+      // install @nuxt/icon
+
+      await installModule("@nuxt/icon", {
+        clientBundle: {
+          scan: true,
+          sizeLimitKb: 256,
+        },
+      })
+
+    }
+
+    {
+
+      // install @vueuse/nuxt
+
+      await installModule("@vueuse/nuxt")
+
+    }
+
+    {
+
+      // install @nuxtjs/i18n
+
+      await installModule("@nuxtjs/i18n")
+
+    }
+
+    {
+
+      // 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',
+        }
+      })
+
+    }
+
+    {
+
+      // add css
+
+      _nuxt.options.css.push('sanitize.css')
+
+    }
+
+    {
+
+      // add components
+
+      addComponentsDir({
+        path: resolve("./runtime/components"),
+        prefix: "",
+        global: true,
+      })
+
+    }
+
+    {
+
+      addPlugin(resolve('./runtime/plugins/resize.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,7 +1,6 @@
 {
   "name": "@owdproject/core",
-  "version": "3.0.0-alpha.9",
-  "description": "Open Web Desktop core",
+  "version": "3.1.1",
   "keywords": [
     "web",
     "desktop",
@@ -18,33 +17,32 @@
     "type": "git",
     "url": "git+https://github.com/owdproject/client.git"
   },
-  "license": "GPL-3.0-or-later",
+  "license": "MIT",
   "author": {
-    "name": "dxlliv",
-    "url": "https://github.com/dxlliv"
+    "name": "Open Web Desktop Team",
+    "url": "https://github.com/owdproject"
   },
+  "type": "module",
+  "types": "types/index.d.ts",
   "dependencies": {
-    "@nuxt/fonts": "^0.11.0",
-    "@nuxt/icon": "^1.11.0",
-    "@nuxtjs/i18n": "^9.4.0",
-    "@nuxtjs/tailwindcss": "^6.13.2",
-    "@pinia/nuxt": "^0.10.1",
-    "@primeuix/themes": "^1.0.0",
-    "@primevue/forms": "^4.3.3",
-    "@primevue/nuxt-module": "^4.3.3",
-    "@vueuse/components": "^13.0.0",
-    "@vueuse/core": "^13.0.0",
-    "@vueuse/nuxt": "^13.0.0",
-    "memfs": "^4.17.0",
+    "@nuxt/kit": "^3.17.2",
+    "@nuxt/fonts": "^0.11.3",
+    "@nuxt/icon": "^1.12.0",
+    "@nuxtjs/i18n": "^9.5.4",
+    "@nuxtjs/tailwindcss": "^6.14.0",
+    "@pinia/nuxt": "^0.11.0",
+    "@primeuix/themes": "^1.1.1",
+    "@primevue/forms": "^4.3.4",
+    "@primevue/nuxt-module": "^4.3.4",
+    "@vueuse/components": "^13.1.0",
+    "@vueuse/core": "^13.1.0",
+    "@vueuse/nuxt": "^13.1.0",
     "mitt": "^3.0.1",
     "nanoid": "^5.1.5",
-    "nuxt": "^3.16.1",
-    "pinia": "^3.0.1",
+    "nuxt": "^3.17.2",
+    "pinia": "^3.0.2",
     "sanitize.css": "^13.0.0",
-    "sass": "^1.86.0",
+    "sass": "^1.88.0",
     "vue-resizable": "^2.1.7"
-  },
-  "resolutions": {
-    "vite": "^6.3.2"
   }
 }

package/runtime/components/Core/Desktop/CoreDesktop.vue

@@ -80,4 +80,4 @@ const classes = computed(() => {
   height: 100dvh;
   user-select: none;
 }
-</style>
+</style>