@owdproject/nuxt 0.0.0-stage → 4.0.0-alpha.3

package/dist/types/index.d.ts

@@ -0,0 +1,156 @@
+import type { Component, Raw, ShallowRef } from 'vue';
+import type { WindowConfig as CoreWindowConfig, WindowState as CoreWindowState, WindowLayout, WindowPosition, WindowSize } from '@owdproject/core';
+export * from '@owdproject/core';
+export interface DesktopWindowConfig extends Omit<CoreWindowConfig, 'component'> {
+    component?: Raw<Component> | any;
+}
+export interface IDesktopWindowActions {
+    setActive(value: boolean): void;
+    setFocus(value: boolean): void;
+    bringToFront(): void;
+    focus(): void;
+    setPosition(data: {
+        x: number;
+        y: number;
+    }): void;
+    startDrag(): void;
+    stopDrag(): void;
+    startResize(): void;
+    stopResize(): void;
+    setSize(data: {
+        width: number;
+        height: number;
+    }): void;
+    minimize(): boolean;
+    unminimize(): boolean;
+    toggleMinimize(): void;
+    toggleMaximize(): boolean;
+    maximize(): boolean;
+    unmaximize(): boolean;
+    setLayout(layout: WindowLayout): boolean;
+    clearLayout(): boolean;
+    saveBoundsBeforeLayout(): void;
+    destroy(): boolean;
+    setWorkspace(workspaceId: string): void;
+    setTitleOverride(value: undefined | string): void;
+    resetTitleOverride(): void;
+    setWindowTitleOverride(value: undefined | string): void;
+    resetWindowTitleOverride(): void;
+}
+export interface IDesktopWindowController {
+    application: any;
+    instanced: boolean;
+    model: string;
+    stateValue: string;
+    config: DesktopWindowConfig;
+    override: Record<string, any>;
+    state: CoreWindowState;
+    meta: any;
+    title: string;
+    windowTitle: string;
+    icon: string | undefined;
+    size: WindowSize;
+    position: WindowPosition | undefined;
+    isMinimizable: boolean;
+    isMaximizable: boolean;
+    isMaximized: boolean;
+    isDestroyable: boolean;
+    isDraggable: boolean;
+    isResizable: boolean;
+    actions: IDesktopWindowActions;
+    menu: any[];
+    setMenu(menu: any[]): void;
+    dispose(): void;
+    destroy(): boolean;
+    startDrag(): void;
+    stopDrag(): void;
+    startResize(): void;
+    stopResize(): void;
+}
+export type VueWindowConfig = DesktopWindowConfig;
+export type IVueWindowActions = IDesktopWindowActions;
+export type IVueWindowController = IDesktopWindowController;
+/** Desktop shell configuration, shared by inline options and desktop.config.ts. */
+export interface DesktopConfig {
+    theme?: string;
+    apps?: string[];
+    modules?: string[];
+    coreVersion?: string;
+    /** Directories a desktop distribution collects extensions from (see {@link DesktopExtensionDirs}). */
+    collect?: DesktopExtensionDirs;
+    [key: string]: any;
+}
+/** Extension kinds a desktop distribution can collect. */
+export type DesktopExtensionKind = 'app' | 'module' | 'theme' | 'kit';
+/** Framework adapters an OWD extension can target (framework-first naming). */
+export type DesktopFramework = 'nuxt' | 'vue' | 'react' | 'svelte' | 'angular' | 'astro';
+/**
+ * Directories a desktop distribution collects extensions from, relative to its root.
+ * Convention: one directory per extension kind. The monorepo keeps framework modules
+ * under `packages/`, so the `modules` slot lists both.
+ */
+export interface DesktopExtensionDirs {
+    apps: string[];
+    modules: string[];
+    themes: string[];
+}
+/**
+ * Minimal declarative contract for a desktop extension. Published extensions surface
+ * it through their Nuxt module `meta` (read at build time by `installDesktopPackage`),
+ * so any framework desktop can classify the package without hard-coding package lists.
+ *
+ * Package naming convention: `<framework>-<kind>-<name>` (e.g. `@owdproject/nuxt-app-todo`,
+ * `@owdproject/react-theme-win95`).
+ */
+export interface DesktopExtensionMeta {
+    /** Extension kind. */
+    kind: DesktopExtensionKind;
+    /** Framework the extension is built for. */
+    framework: DesktopFramework;
+    /** Full package name, e.g. `@owdproject/nuxt-app-todo`. */
+    packageName?: string;
+    /** Runtime namespace on `runtimeConfig.public.desktop[...]`. */
+    configKey?: string;
+    /** Build-time entry (Nuxt module). Defaults to the package root export. */
+    entry?: string;
+    /** Framework adapter required at runtime, e.g. `@owdproject/nuxt`. */
+    adapter?: string;
+    /** Kits/modules the extension expects the active theme or desktop to provide. */
+    requires?: string[];
+}
+export interface IWindowController extends IDesktopWindowController {
+    readonly application: IApplicationController;
+}
+export type IWindowActions = IDesktopWindowActions;
+export interface IApplicationController {
+    readonly id: string;
+    readonly config: import('@owdproject/core').ApplicationConfig;
+    readonly windows: Map<string, IWindowController>;
+    readonly windowsOpened: Map<string, IWindowController>;
+    readonly openWindowCount: ShallowRef<number>;
+    readonly storeWindows?: any;
+    readonly storeMeta?: any;
+    readonly pid: number | null;
+    readonly startedAt: number | null;
+    readonly stateValue: string;
+    readonly isRunning: boolean;
+    readonly isSuspended: boolean;
+    readonly isInitializing: boolean;
+    readonly isReady: boolean;
+    initApplication(): Promise<void>;
+    openWindow(model: string, storedState?: import('@owdproject/core').WindowStoredState, meta?: Record<string, any>): IWindowController | undefined;
+    getFirstWindowByModel(model: string): IWindowController | undefined;
+    closeWindow(windowId: string): void;
+    closeAllWindows(): void;
+    focusWindow(win: IWindowController): void;
+    setRunning(value: boolean): void;
+    suspend(): void;
+    resume(): void;
+    sendSignal(signal: 'SIGTERM' | 'SIGKILL' | 'SIGSTOP' | 'SIGCONT'): void;
+    execCommand(command: string): Promise<import('@owdproject/core').CommandOutput | void>;
+}
+export interface DesktopSystemBarConfig {
+    enabled?: boolean;
+    position?: 'top' | 'bottom';
+    startButton?: boolean;
+}

package/dist/types/index.js

@@ -0,0 +1 @@
+export * from "@owdproject/core";

package/dist/types.d.mts

@@ -0,0 +1,2 @@
+export * from './module.mjs'
+export { default } from './module.mjs'

package/package.json

@@ -1,6 +1,147 @@
 {
   "name": "@owdproject/nuxt",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "4.0.0-alpha.3",
+  "description": "Official Nuxt & Vue desktop engine for OpenWebDesktop",
+  "homepage": "https://github.com/owdproject/nuxt#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/owdproject/nuxt.git"
+  },
+  "author": {
+    "name": "Diego Villa (@dxlliv)",
+    "url": "https://github.com/dxlliv"
+  },
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/module.mjs",
+  "module": "./dist/module.mjs",
+  "types": "./dist/types.d.mts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "tag": "alpha",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.mts",
+      "import": "./dist/module.mjs",
+      "default": "./dist/module.mjs"
+    },
+    "./package.json": "./package.json",
+    "./kit": {
+      "types": "./dist/kit/authoring.d.ts",
+      "import": "./dist/kit/authoring.js",
+      "default": "./dist/kit/authoring.js"
+    },
+    "./kit/defineDesktopApp": {
+      "types": "./dist/kit/defineDesktopApp.d.ts",
+      "import": "./dist/kit/defineDesktopApp.js",
+      "default": "./dist/kit/defineDesktopApp.js"
+    },
+    "./kit/defineDesktopPlugin": {
+      "types": "./dist/kit/defineDesktopPlugin.d.ts",
+      "import": "./dist/kit/defineDesktopPlugin.js",
+      "default": "./dist/kit/defineDesktopPlugin.js"
+    },
+    "./kit/defineDesktopTheme": {
+      "types": "./dist/kit/authoring.d.ts",
+      "import": "./dist/kit/authoring.js",
+      "default": "./dist/kit/authoring.js"
+    },
+    "./kit/defineDesktopConfig": {
+      "types": "./dist/kit/authoring.d.ts",
+      "import": "./dist/kit/authoring.js",
+      "default": "./dist/kit/authoring.js"
+    },
+    "./kit/*": {
+      "types": "./dist/kit/*.d.ts",
+      "import": "./dist/kit/*.js",
+      "default": "./dist/kit/*.js"
+    },
+    "./runtime/composables/*": {
+      "types": "./dist/runtime/composables/*.d.ts",
+      "import": "./dist/runtime/composables/*.js",
+      "default": "./dist/runtime/composables/*.js"
+    },
+    "./runtime/constants/*": {
+      "types": "./dist/runtime/constants/*.d.ts",
+      "import": "./dist/runtime/constants/*.js",
+      "default": "./dist/runtime/constants/*.js"
+    },
+    "./runtime/dialogs/*": {
+      "types": "./dist/runtime/dialogs/*.d.ts",
+      "import": "./dist/runtime/dialogs/*.js",
+      "default": "./dist/runtime/dialogs/*.js"
+    },
+    "./runtime/utils/*": {
+      "types": "./dist/runtime/utils/*.d.ts",
+      "import": "./dist/runtime/utils/*.js",
+      "default": "./dist/runtime/utils/*.js"
+    },
+    "./runtime/stores/*": {
+      "types": "./dist/runtime/stores/*.d.ts",
+      "import": "./dist/runtime/stores/*.js",
+      "default": "./dist/runtime/stores/*.js"
+    },
+    "./runtime/components/*": {
+      "types": "./dist/runtime/components/*.vue.d.ts",
+      "import": "./dist/runtime/components/*.vue",
+      "default": "./dist/runtime/components/*.vue"
+    },
+    "./runtime/types/*": {
+      "types": "./dist/runtime/types/*.d.ts",
+      "import": "./dist/runtime/types/*.js",
+      "default": "./dist/runtime/types/*.js"
+    },
+    "./runtime/*": {
+      "types": "./dist/runtime/*.d.ts",
+      "import": "./dist/runtime/*.js",
+      "default": "./dist/runtime/*.js"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./dist/types.d.mts"
+      ]
+    }
+  },
+  "scripts": {
+    "build": "nuxt-module-build build && node ./scripts/post-build-pkg-nuxt.mjs",
+    "prepack": "nuxt-module-build build && node ./scripts/post-build-pkg-nuxt.mjs"
+  },
+  "dependencies": {
+    "@nuxt/fonts": "^1.2.0",
+    "@nuxt/icon": "^2.6.1",
+    "@nuxt/kit": "^4.6.2",
+    "@nuxtjs/i18n": "^10.6.0",
+    "@owdproject/core": "^4.0.0-alpha.3",
+    "@pinia/nuxt": "^1.0.3",
+    "@vueuse/components": "^15.0.0",
+    "@vueuse/core": "^15.0.0",
+    "@vueuse/nuxt": "^15.0.0",
+    "defu": "^6.1.7",
+    "getopts": "^2.3.0",
+    "hookable": "^6.1.2",
+    "nanoid": "^6.0.2",
+    "pinia": "^4.1.0",
+    "sanitize.css": "^13.0.0",
+    "sass": "^1.106.1",
+    "shellwords": "^1.1.1",
+    "three": "^0.186.1",
+    "xstate": "^5.33.3"
+  },
+  "peerDependencies": {
+    "nuxt": ">=3.0.0 || >=4.0.0",
+    "vue": ">=3.3.0"
+  },
+  "peerDependenciesMeta": {
+    "nuxt": {
+      "optional": true
+    }
+  }
+}