@owdproject/core 3.1.1 → 3.1.3

package/README.md

@@ -8,9 +8,9 @@
 
 ## Overview
 
-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.
+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/) · [Documentation](https://owdproject.org/)
+[Demo](https://atproto-os.pages.dev/) · [Community](https://discord.gg/zPNaN2HAaA) · [Documentation](https://owdproject.org/)
 
 ## Features
 
@@ -44,80 +44,46 @@ pnpm run generate
 
 ## Extend your desktop
 
-Open Web Desktop can be extended with themes, modules and applications.
+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.
 
-### Install an application
+[Applications](https://github.com/topics/owd-apps) · [Modules](https://github.com/topics/owd-modules) · [Themes](https://github.com/topics/owd-themes)
 
-You can install a new [application](https://github.com/topics/owd-apps) with:
+### 🧩 Install an application
+
+You can discover new apps by searching for the [owd-apps](https://github.com/topics/owd-apps) tag on GitHub.
+
+For example, to install the To-do app:
 
 ```bash
-pnpm install @owdproject/app-todo
+owd install-app @owdproject/app-todo
 ```
 
-Then, define it in the desktop configuration:
-
-```typescript
-// desktop/owd.config.ts
-export default defineDesktopConfig({
-    theme: "@owdproject/theme-win95",
-    apps: [
-        "@owdproject/app-about",
-        "@owdproject/app-todo", // define here the app you just installed
-    ],
-    modules: []
-})
-```
+This will install the package and automatically register it in your desktop configuration.
+
+### 🧩 Install a module
 
-### Install a module
+You can discover new modules by searching for the [owd-modules](https://github.com/topics/owd-modules) tag on GitHub.
 
-You can install a new [module](https://github.com/topics/owd-modules) with:
+For example, to install the session persistence module:
 
 ```bash
-pnpm install @owdproject/module-pinia-localforage
+owd install-module @owdproject/module-pinia-localforage
 ```
 
-Then, define it in the desktop configuration:
-
-```typescript
-// desktop/owd.config.ts
-export default defineDesktopConfig({
-    theme: "@owdproject/theme-win95",
-    apps: [
-        "@owdproject/app-about",
-        "@owdproject/app-todo",
-    ],
-    modules: [
-        "@owdproject/module-pinia-localforage", // define here the module you just installed
-    ]
-})
-```
+### 🖥️ Themes
 
-## Themes
-You can install a new [theme](https://github.com/topics/owd-themes) in the same way.
+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.
 
-```bash
-pnpm install @owdproject/theme-gnome
-```
+You can discover new themes by searching for the [owd-themes](https://github.com/topics/owd-themes) tag on GitHub.
 
-Define the theme in `owd.config.ts`:
-
-```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"
-    ]
-})
+```bash
+owd install-theme @owdproject/theme-gnome
 ```
 
 ## Sponsors
 
-Make this project sustainable, your support is crucial to keep it moving forward.
+Be the first to support this project and help us keep it growing! [Sponsor the project](https://github.com/sponsors/owdproject)
 
 ## License
 

package/bin/owd.js

@@ -0,0 +1,28 @@
+#!/usr/bin/env node
+
+import { spawn } from 'child_process';
+
+const [, , cmd, pkgName, ...rest] = process.argv;
+
+const commandMap = {
+  "install-app": "desktop:install-app",
+  "install-module": "desktop:install-module",
+  "install-theme": "desktop:install-theme",
+};
+
+if (!commandMap[cmd]) {
+  console.error(`Unknown command: ${cmd}`);
+  process.exit(1);
+}
+
+if (!pkgName) {
+  console.error("Missing package name (e.g., @owdproject/package)");
+  process.exit(1);
+}
+
+const nxArgs = ["run", commandMap[cmd], `--name=${pkgName}`, ...rest];
+
+const child = spawn("pnpm", ["nx", ...nxArgs], {
+  stdio: "inherit",
+  shell: true,
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@owdproject/core",
-  "version": "3.1.1",
+  "version": "3.1.3",
   "keywords": [
     "web",
     "desktop",
@@ -24,6 +24,9 @@
   },
   "type": "module",
   "types": "types/index.d.ts",
+  "bin": {
+    "owd": "./bin/owd.js"
+  },
   "dependencies": {
     "@nuxt/kit": "^3.17.2",
     "@nuxt/fonts": "^0.11.3",

package/runtime/core/controllers/WindowController.ts

@@ -1,8 +1,8 @@
-import {useApplicationManager} from '../../composables/useApplicationManager'
-import {useDesktopWindowStore} from '../../stores/storeDesktopWindow'
-import {deepClone} from '../../utils/utilCommon'
-import {markRaw} from '@vue/reactivity'
-import {defineAsyncComponent} from "vue"
+import { useApplicationManager } from '../../composables/useApplicationManager'
+import { useDesktopWindowStore } from '../../stores/storeDesktopWindow'
+import { deepClone } from '../../utils/utilCommon'
+import { markRaw } from '@vue/reactivity'
+import { defineAsyncComponent } from 'vue'
 
 export class WindowController implements IWindowController {
     public readonly application: IApplicationController
@@ -70,7 +70,7 @@ export class WindowController implements IWindowController {
         // component
         if (config.component) {
             this.config.component = markRaw(
-                defineAsyncComponent(config.component)
+                defineAsyncComponent(config.component),
             )
         }
 
@@ -87,10 +87,14 @@ export class WindowController implements IWindowController {
         // sizes
         if (config.size?.width) this.config.size.width = config.size.width
         if (config.size?.height) this.config.size.height = config.size.height
-        if (config.size?.minWidth) this.config.size.minWidth = config.size.minWidth
-        if (config.size?.minHeight) this.config.size.minHeight = config.size.minHeight
-        if (config.size?.maxWidth) this.config.size.maxWidth = config.size.maxWidth
-        if (config.size?.maxHeight) this.config.size.maxHeight = config.size.maxHeight
+        if (config.size?.minWidth)
+            this.config.size.minWidth = config.size.minWidth
+        if (config.size?.minHeight)
+            this.config.size.minHeight = config.size.minHeight
+        if (config.size?.maxWidth)
+            this.config.size.maxWidth = config.size.maxWidth
+        if (config.size?.maxHeight)
+            this.config.size.maxHeight = config.size.maxHeight
 
         // minimize
         if (typeof config.minimizable !== 'undefined') {
@@ -137,7 +141,7 @@ export class WindowController implements IWindowController {
 
         this.config.overridable = {
             ...DEFAULT_OVERRIDABLE,
-            ...(config.overridable || {})
+            ...(config.overridable || {}),
         }
     }
 
@@ -173,24 +177,24 @@ export class WindowController implements IWindowController {
 
     // position
 
-    private setPosition(data: { x: number, y: number}) {
+    public setPosition(data: { x: number; y: number }) {
         if (!this.state.position) {
-            this.state.position = { x: 0, y: 0}
+            this.state.position = { x: 0, y: 0 }
         }
 
         this.state.position.x = data.x
         this.state.position.y = data.y
     }
 
-    private setActive(value: boolean) {
+    public setActive(value: boolean) {
         this.state.active = value
     }
 
-    private setFocus(value: boolean) {
+    public setFocus(value: boolean) {
         this.state.focused = value
     }
 
-    private bringToFront() {
+    public focus() {
         const applicationManager = useApplicationManager()
         const desktopWindowStore = useDesktopWindowStore()
 
@@ -256,16 +260,34 @@ export class WindowController implements IWindowController {
         const configSize = this.config.size || {}
 
         return {
-            width: typeof stateSize.width !== 'undefined' ? stateSize.width : configSize.width,
-            height: typeof stateSize.height !== 'undefined' ? stateSize.height : configSize.height,
-            minWidth: typeof stateSize.minWidth !== 'undefined' ? stateSize.minWidth : configSize.minWidth,
-            maxWidth: typeof stateSize.maxWidth !== 'undefined' ? stateSize.maxWidth : configSize.maxWidth,
-            minHeight: typeof stateSize.minHeight !== 'undefined' ? stateSize.minHeight : configSize.minHeight,
-            maxHeight: typeof stateSize.maxHeight !== 'undefined' ? stateSize.maxHeight : (configSize.maxHeight ?? 600),
+            width:
+                typeof stateSize.width !== 'undefined'
+                    ? stateSize.width
+                    : configSize.width,
+            height:
+                typeof stateSize.height !== 'undefined'
+                    ? stateSize.height
+                    : configSize.height,
+            minWidth:
+                typeof stateSize.minWidth !== 'undefined'
+                    ? stateSize.minWidth
+                    : configSize.minWidth,
+            maxWidth:
+                typeof stateSize.maxWidth !== 'undefined'
+                    ? stateSize.maxWidth
+                    : configSize.maxWidth,
+            minHeight:
+                typeof stateSize.minHeight !== 'undefined'
+                    ? stateSize.minHeight
+                    : configSize.minHeight,
+            maxHeight:
+                typeof stateSize.maxHeight !== 'undefined'
+                    ? stateSize.maxHeight
+                    : (configSize.maxHeight ?? 600),
         }
     }
 
-    private setSize(data: { width: number, height: number}) {
+    public setSize(data: { width: number; height: number }) {
         if (!this.state.size) {
             this.state.size = { width: undefined, height: undefined }
         }
@@ -284,7 +306,7 @@ export class WindowController implements IWindowController {
         return !!this.config.minimizable
     }
 
-    private minimize() {
+    public minimize() {
         if (!this.isMinimizable) {
             return false
         }
@@ -293,9 +315,14 @@ export class WindowController implements IWindowController {
         return true
     }
 
-    private toggleMinimize() {
+    public unminimize() {
+        this.state.active = true
+        return true
+    }
+
+    public toggleMinimize() {
         this.state.active = !this.state.active
-        this.bringToFront()
+        this.focus()
     }
 
     // maximize
@@ -316,7 +343,7 @@ export class WindowController implements IWindowController {
         return !!this.config.maximized
     }
 
-    private toggleMaximize() {
+    public toggleMaximize() {
         if (!this.isMaximizable) {
             return false
         }
@@ -325,7 +352,7 @@ export class WindowController implements IWindowController {
         return true
     }
 
-    private maximize() {
+    public maximize() {
         if (!this.isMaximizable) {
             return false
         }
@@ -334,7 +361,7 @@ export class WindowController implements IWindowController {
         return true
     }
 
-    private unmaximize() {
+    public unmaximize() {
         if (!this.isMaximizable) {
             return false
         }
@@ -353,7 +380,7 @@ export class WindowController implements IWindowController {
         return !!this.config.destroyable
     }
 
-    private destroy() {
+    public destroy() {
         if (!this.isDestroyable) {
             return false
         }
@@ -382,26 +409,28 @@ export class WindowController implements IWindowController {
     }
 
     // workspace
-    private setWorkspace(workspaceId: string) {
+    public setWorkspace(workspaceId: string) {
         this.state.workspace = workspaceId
     }
 
     // override
 
-    setTitleOverride(value: undefined|string) {
+    public setTitleOverride(value: undefined | string) {
         this.override.title = value
     }
 
-    resetTitleOverride() {
+    public resetTitleOverride() {
         this.override.title = undefined
     }
 
+    // deprecated ?
     get actions() {
         return {
             // position
             setActive: this.setActive.bind(this),
             setFocus: this.setFocus.bind(this),
-            bringToFront: this.bringToFront.bind(this),
+            bringToFront: this.focus.bind(this),
+            focus: this.focus.bind(this),
             setPosition: this.setPosition.bind(this),
 
             // size

package/.editorconfig

@@ -1,12 +0,0 @@
-root = true
-
-[*]
-indent_size = 2
-indent_style = space
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.md]
-trim_trailing_whitespace = false