@owdproject/core 3.0.0-alpha.7 → 3.0.0-alpha.9

package/README.md

@@ -56,52 +56,48 @@ export default defineDesktopConfig({
 
 ## 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).
 
 ### Install a new theme
-You can install a new theme by defining it as a Nuxt.js layer in `nuxt.config.ts`.  
+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.
 
-**1. Using a local theme:**
+#### Using a local theme
 
-Clone it first in a folder of your project like `./desktop/theme/theme-win95`.
+Clone it first in a folder of your project like `./desktop/theme/theme-gnome`.
 
 ```bash
-git clone git@github.com:owdproject/theme-win95.git ./desktop/theme/theme-win95
+git clone git@github.com:owdproject/theme-gnome.git ./desktop/theme/theme-gnome
 ```
 
-Then specify the path theme in the `nuxt.config.ts` configuration:
+Then specify the path theme in `owd.config.ts`:
 
 ```typescript
-// nuxt.config.ts
-export default defineNuxtConfig({
-    modules: [
-        "@owdproject/core",
-    ],
-
-    extends: [
-        "./desktop/theme/theme-win95"
-    ],
-    
+// owd.config.ts
+export default defineDesktopConfig({
+    theme: './dev/themes/theme-gnome', // define here the theme you just cloned
+    apps: [
     ...
 ```
 
-**2. Using a theme from GitHub:**
+#### Using a theme package
+
+Use npm to install the theme package as a dependency of your Open Web Desktop client:
+
+```bash
+npm install @owdproject/theme-gnome
+```
 
-To use a theme directly specifying  a GitHub repository, use this format: `github:<username>/<repository>`:
+Then specify the path theme in `owd.config.ts`:
 
 ```typescript
-// nuxt.config.ts
-export default defineNuxtConfig({
-    modules: [
-        "@owdproject/core",
-    ],
-
-    extends: [
-        "github:owdproject/theme-gnome",
-        { install: true }
-    ],
-    
-    ...
+// owd.config.ts
+import {defineDesktopConfig} from "@owdproject/core/runtime/utils/utilDesktop"
+
+export default defineDesktopConfig({
+    theme: '@owdproject/theme-gnome', // define here the theme you just installed
+    apps: [
+        ...
 ```
 
 ## Contributing
@@ -143,10 +139,10 @@ npm run dev
 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.
 
-## Getting Involved
+## Sponsoring
 
 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.
 
-### License
+## License
 
 Open Web Desktop is released under the [GNU General Public License v3](LICENSE).

package/index.ts

@@ -1,5 +1,5 @@
 import {defineNuxtModule, createResolver, addComponentsDir, addImportsDir, installModule, addPlugin} from '@nuxt/kit'
-import {useDesktopManager} from './runtime/composables/useDesktopManager'
+import {deepMerge} from '@owdproject/core/runtime/utils/utilCommon'
 import pkg from './package.json'
 
 export default defineNuxtModule({
@@ -9,24 +9,43 @@ export default defineNuxtModule({
     },
     async setup(options, nuxt) {
         const {resolve} = createResolver(import.meta.url)
-        const desktopManager = useDesktopManager()
 
-        await import(nuxt.options.rootDir + '/owd.config.ts')
+        const desktopConfig = (await import(nuxt.options.rootDir + '/owd.config.ts')).default
 
-        // set core version to runtime variables
+        // 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 (desktopManager.config.apps) {
-                for (const appPath of desktopManager.config.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
+            )
+
         }
 
         {
@@ -157,15 +176,16 @@ export default defineNuxtModule({
 
 export * from './runtime/composables/useAppEntries'
 export * from './runtime/composables/useApplicationManager'
-export * from './runtime/composables/useApplicationState'
 export * from './runtime/composables/useDesktopManager'
 export * from './runtime/composables/useTerminalManager'
-export * from './runtime/utils/utilsApp'
-export * from './runtime/utils/utilsCommon'
-export * from './runtime/utils/utilsDebug'
-export * from './runtime/utils/utilsDesktop'
-export * from './runtime/utils/utilsTerminal'
-export * from './runtime/utils/utilsWindow'
+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'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@owdproject/core",
-  "version": "3.0.0-alpha.7",
+  "version": "3.0.0-alpha.9",
   "description": "Open Web Desktop core",
   "keywords": [
     "web",
@@ -43,5 +43,8 @@
     "sanitize.css": "^13.0.0",
     "sass": "^1.86.0",
     "vue-resizable": "^2.1.7"
+  },
+  "resolutions": {
+    "vite": "^6.3.2"
   }
 }

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

@@ -1,5 +1,6 @@
 <script setup lang="ts">
 import {onMounted, onUnmounted} from "vue"
+import {useRuntimeConfig} from "nuxt/app"
 import {computed, toRaw} from "@vue/reactivity"
 import {useDesktopManager} from "../../../composables/useDesktopManager"
 import {useApplicationManager} from "../../../composables/useApplicationManager"
@@ -10,16 +11,21 @@ const props = withDefaults(defineProps<{
   windows?: DesktopWindowsConfig
   systemBar?: DesktopSystemBarConfig
   dockBar?: DesktopDockBarConfig
+  workspaces?: DesktopWorkspacesConfig
 }>(), {
   windows: {
     position: 'fixed',
   },
   systemBar: {},
   dockBar: {},
+  workspaces: {},
 })
 
+// todo move to owd initialization
+
 const desktopManager = useDesktopManager()
 const applicationManager = useApplicationManager()
+const runtimeConfig = useRuntimeConfig()
 
 // create firsts workspaces if not available
 const desktopStore = useDesktopStore()
@@ -33,11 +39,14 @@ if (desktopStore.$persistedState) {
   desktopWorkspaceStore.setupWorkspaces()
 }
 
+desktopManager.setConfig(runtimeConfig.public.desktop)
+
 // override desktop configurations
 desktopManager.setConfig({
   windows: toRaw(props.windows),
-  systemBar: toRaw( props.systemBar),
+  systemBar: toRaw(props.systemBar),
   dockBar: toRaw(props.dockBar),
+  workspaces: toRaw(props.workspaces),
 })
 
 // desktop resize

package/runtime/components/Core/Window/CoreWindow.vue

@@ -1,8 +1,8 @@
 <script setup lang="ts">
 import {ref,provide} from 'vue'
 import {computed} from "@vue/reactivity"
-import {useDesktopManager} from "../../../composables/useDesktopManager"
-import {handleWindowControllerProps} from "../../../utils/utilsWindow"
+import {useDesktopManager} from "@owdproject/core/runtime/composables/useDesktopManager"
+import {handleWindowControllerProps} from "@owdproject/core/runtime/utils/utilWindow"
 
 const props = defineProps<{
   window?: IWindowController

package/runtime/core/controllers/ApplicationController.ts

@@ -1,10 +1,11 @@
 import {nanoid} from "nanoid";
 import {WindowController} from "./WindowController";
 import {useApplicationManager} from "../../composables/useApplicationManager"
-import {useApplicationState} from "../../composables/useApplicationState"
+import {useApplicationWindowsStore} from "../../stores/storeApplicationWindows"
+import {useApplicationMetaStore} from "../../stores/storeApplicationMeta"
 import {useTerminalManager} from "../../composables/useTerminalManager"
 import {useDesktopManager} from "../../composables/useDesktopManager"
-import {debugLog, debugError} from "../../utils/utilsDebug"
+import {debugLog, debugError} from "../../utils/utilDebug"
 import {useDesktopWorkspaceStore} from "../../stores/storeDesktopWorkspace"
 import {reactive} from '@vue/reactivity'
 
@@ -31,7 +32,8 @@ export class ApplicationController implements IApplicationController {
 
         this.id = id
         this.config = config
-        this.store = useApplicationState(id)
+        this.storeWindows = useApplicationWindowsStore(id)
+        this.storeMeta = useApplicationMetaStore(id)
     }
 
     public async initApplication(): Promise<void> {
@@ -67,12 +69,16 @@ export class ApplicationController implements IApplicationController {
 
         // store
 
-        if (this.store.$persistedState) {
-            await this.store.$persistedState.isReady()
+        if (this.storeWindows.$persistedState) {
+            await this.storeWindows.$persistedState.isReady()
+        }
+
+        if (this.storeMeta.$persistedState) {
+            await this.storeMeta.$persistedState.isReady()
         }
 
         // set default meta values
-        this.store.meta = this.config.meta ?? {}
+        // this.storeMeta.meta = this.config.meta ?? {}
 
         // restore application state
         await this.restoreApplication()
@@ -94,7 +100,7 @@ export class ApplicationController implements IApplicationController {
             await this.config.onRestore(this)
         }
 
-        if (!this.store.windows || Object.keys(this.store.windows).length === 0) {
+        if (!this.storeWindows.windows || Object.keys(this.storeWindows.windows).length === 0) {
             return false
         }
 
@@ -106,8 +112,8 @@ export class ApplicationController implements IApplicationController {
     }
 
     private restoreWindows() {
-        Object.keys(this.store.windows).map(windowId => {
-            const windowStore: WindowStoredState | undefined = this.store.windows[windowId]
+        Object.keys(this.storeWindows.windows).map(windowId => {
+            const windowStore: WindowStoredState | undefined = this.storeWindows.windows[windowId]
 
             if (windowStore) {
                 this.openWindow(windowStore.model, windowStore, {isRestoring: true})
@@ -138,7 +144,7 @@ export class ApplicationController implements IApplicationController {
                 ? window.scrollY + windowConfig.position.y
                 : window.scrollY + centerY
 
-            this.store.windows[windowId] = {
+            this.storeWindows.windows[windowId] = {
                 model,
                 state: {
                     id: windowId,
@@ -153,7 +159,7 @@ export class ApplicationController implements IApplicationController {
                 }
             }
 
-            windowStoredState = this.store.windows[windowId]
+            windowStoredState = this.storeWindows.windows[windowId]
 
         } else {
 
@@ -186,7 +192,7 @@ export class ApplicationController implements IApplicationController {
     }
 
     public closeWindow(windowId: string) {
-        delete this.store.windows[windowId];
+        delete this.storeWindows.windows[windowId];
         this.windows.delete(windowId);
 
         if (this.windows.size === 0) {
@@ -195,7 +201,7 @@ export class ApplicationController implements IApplicationController {
     }
 
     public closeAllWindows() {
-        this.store.windows = {}
+        this.storeWindows.windows = {}
         this.windows.clear()
     }
 
@@ -210,7 +216,7 @@ export class ApplicationController implements IApplicationController {
     // meta
 
     get meta() {
-        return this.store.meta
+        return this.storeMeta.meta
     }
 
     getMeta(key: string) {

package/runtime/core/controllers/WindowController.ts

@@ -1,6 +1,6 @@
-import {useApplicationManager} from '../../composables/useApplicationManager'
-import {useDesktopWindowStore} from '../../stores/storeDesktopWindow'
-import {deepClone} from '../../utils/utilsCommon'
+import {useApplicationManager} from '@owdproject/core/runtime/composables/useApplicationManager'
+import {useDesktopWindowStore} from '@owdproject/core/runtime/stores/storeDesktopWindow'
+import {deepClone} from '@owdproject/core/runtime/utils/utilCommon'
 import {markRaw} from '@vue/reactivity'
 import {defineAsyncComponent} from "vue"
 

package/runtime/core/managers/ApplicationManager.ts

@@ -1,8 +1,8 @@
 import type {Reactive} from "@vue/reactivity"
 import {reactive, markRaw} from "@vue/reactivity"
 import {ApplicationController} from "../controllers/ApplicationController";
-import {normalizeApplicationConfig} from "../../utils/utilsApp"
-import {debugLog} from "../../utils/utilsDebug"
+import {normalizeApplicationConfig} from "../../utils/utilApp"
+import {debugLog} from "../../utils/utilDebug"
 
 export class ApplicationManager implements IApplicationManager {
     public apps = reactive(

package/runtime/core/managers/DesktopManager.ts

@@ -1,7 +1,8 @@
-import {deepMerge} from "../../utils/utilsCommon"
+import {deepMerge} from "@owdproject/core/runtime/utils/utilCommon"
 
 export class DesktopManager {
     public config: DesktopConfig = {} as DesktopConfig
+
     private defaultApps: DefaultAppsConfig = {}
 
     constructor() {
@@ -30,7 +31,7 @@ export class DesktopManager {
 
     private loadDefaultAppsFromConfig() {
         if (this.config.defaultApps) {
-            this.defaultApps = { ...this.config.defaultApps }
+            this.defaultApps = {...this.config.defaultApps}
         }
     }
 }

package/runtime/core/managers/TerminalManager.ts

@@ -1,5 +1,5 @@
 import {useApplicationManager} from "../../composables/useApplicationManager"
-import {debugLog} from "../../utils/utilsDebug"
+import {debugLog} from "../../utils/utilDebug"
 
 export class TerminalManager {
     private commands: Map<string, TerminalCommand> = new Map()

package/runtime/stores/storeApplicationMeta.ts

@@ -0,0 +1,11 @@
+import {defineStore} from "pinia"
+
+export const useApplicationMetaStore = (appId: string, states: any = {}) => {
+    return defineStore(`owd/application/${appId}/meta`, () => {
+        return states
+    }, {
+        persistedState: {
+            persist: true
+        },
+    })
+}

package/runtime/{composables/useApplicationState.ts → stores/storeApplicationWindows.ts}

@@ -1,15 +1,12 @@
 import {defineStore} from "pinia"
 import {ref} from "@vue/reactivity"
 
-export const useApplicationState = (appId: string) => {
-    return defineStore(`owd/application/${appId}`, () => {
-        const meta: Ref<any> = ref({})
-
+export const useApplicationWindowsStore = (appId: string) => {
+    return defineStore(`owd/application/${appId}/windows`, () => {
         const windows: Ref<{[windowId: string]: WindowStoredState}> = ref({})
 
         return {
             windows,
-            meta,
         }
     }, {
         persistedState: {

package/runtime/utils/{utilsDesktop.ts → utilDesktop.ts}

@@ -7,7 +7,5 @@ export function defineDesktopApp(config: ApplicationConfig) {
 }
 
 export function defineDesktopConfig(config: DesktopConfig) {
-    const desktopManager = useDesktopManager()
-    desktopManager.setConfig(config)
-    return true
+    return config
 }

package/types/owd.d.ts

@@ -276,13 +276,17 @@ interface IDesktopManager {
 }
 
 interface DesktopConfig {
-    name?: string
-    compatibility?: string
+    theme?: string
+    modules?: string[]
     apps?: string[]
+
+    name?: string
     defaultApps?: DefaultAppsConfig
     features?: string[]
+
     systemBar?: DesktopSystemBarConfig
     dockBar?: DesktopDockBarConfig
+    workspaces?: DesktopWorkspacesConfig
 }
 
 interface DesktopWindowsConfig {
@@ -300,6 +304,10 @@ interface DesktopSystemBarConfig {
     startButton?: boolean
 }
 
+interface DesktopWorkspacesConfig {
+    enabled?: boolean
+}
+
 // TERMINAL
 
 type TerminalCommand = {

package/types/index.d.ts

@@ -1,9 +0,0 @@
-declare module 'nuxt/schema' {
-  interface AppConfig {
-    owd: {
-      apps: string[]
-    }
-  }
-}
-
-export {}