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

package/dist/module.d.mts

@@ -0,0 +1,239 @@
+import * as _nuxt_schema from '@nuxt/schema';
+import * as _owdproject_core from '@owdproject/core';
+import { WindowConfig, WindowState, WindowSize, WindowPosition, WindowLayout, Desktop, DesktopOptions, WindowInstance, ApplicationInstance, WorkspaceState, DesktopCommand, DesktopKernelEvent, WindowManager, WindowBounds, DesktopWorkareaRect, SnapZoneHint, ResizeDirection, WindowOverride, WindowStoredState, WindowSizeValue } from '@owdproject/core';
+export * from '@owdproject/core';
+import { Raw, Component, ShallowRef, ComputedRef } from 'vue';
+export { defineDesktopConfig, defineDesktopModule, defineDesktopTheme, hasDesktopModule, mergeDesktopExtensionConfig, setDesktopExtensionConfig } from '../dist/kit/authoring.js';
+export * from '../dist/types/index.js';
+
+interface DesktopWindowConfig extends Omit<WindowConfig, 'component'> {
+    component?: Raw<Component> | any;
+}
+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;
+}
+interface IDesktopWindowController {
+    application: any;
+    instanced: boolean;
+    model: string;
+    stateValue: string;
+    config: DesktopWindowConfig;
+    override: Record<string, any>;
+    state: WindowState;
+    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;
+}
+/** Desktop shell configuration, shared by inline options and desktop.config.ts. */
+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;
+}
+/**
+ * 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.
+ */
+interface DesktopExtensionDirs {
+    apps: string[];
+    modules: string[];
+    themes: string[];
+}
+
+declare function useDesktop(desktopOrOptions?: Desktop | DesktopOptions): {
+    desktop: Desktop;
+    windows: ShallowRef<readonly WindowInstance[]>;
+    applications: ShallowRef<readonly ApplicationInstance[]>;
+    workspace: ShallowRef<WorkspaceState>;
+    commands: ShallowRef<readonly DesktopCommand[]>;
+    events: ShallowRef<readonly DesktopKernelEvent[]>;
+    focusedWindow: ComputedRef<WindowInstance | undefined>;
+};
+
+declare function useWindowManager(manager?: WindowManager): {
+    windows: ShallowRef<WindowInstance[]>;
+    focused: ComputedRef<WindowInstance | undefined>;
+    manager: WindowManager;
+};
+declare const useVueWindowManager: typeof useWindowManager;
+
+declare function useWindowInstance(instance: WindowInstance): {
+    state: ShallowRef<WindowState>;
+    instance: WindowInstance;
+};
+
+interface DesktopDragOptions {
+    getBounds: () => WindowBounds;
+    getWorkarea?: () => DesktopWorkareaRect | undefined;
+    onStart?: () => void;
+    onMove?: (bounds: WindowBounds, snapZone: SnapZoneHint | null) => void;
+    onEnd?: (finalBounds: WindowBounds, snapZone: SnapZoneHint | null) => void;
+    onCancel?: () => void;
+}
+declare function useDesktopDrag(options: DesktopDragOptions): {
+    startDrag: (event: PointerEvent) => () => void;
+};
+interface DesktopResizeOptions {
+    getBounds: () => WindowBounds;
+    minWidth?: number;
+    minHeight?: number;
+    maxWidth?: number;
+    maxHeight?: number;
+    onStart?: () => void;
+    onMove?: (bounds: WindowBounds) => void;
+    onEnd?: (finalBounds: WindowBounds) => void;
+    onCancel?: () => void;
+}
+declare function useDesktopResize(options: DesktopResizeOptions): {
+    startResize: (event: PointerEvent, direction: ResizeDirection) => () => void;
+};
+
+declare class WindowController implements IDesktopWindowController {
+    readonly application: any;
+    readonly instanced: boolean;
+    readonly model: string;
+    private readonly _stateValue;
+    get stateValue(): string;
+    config: WindowConfig;
+    override: WindowOverride;
+    private storedState;
+    private windowActor;
+    private isDisposed;
+    readonly actions: IDesktopWindowActions;
+    constructor(application: any, model: string, windowConfig: WindowConfig, windowStoredState: WindowStoredState, options?: {
+        onFocus?: (win: WindowController) => void;
+        onLayoutChange?: (win: WindowController, layout: WindowLayout) => void;
+        getWorkarea?: () => {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        incrementPositionZ?: () => number;
+        getWindows?: () => WindowController[];
+    });
+    private setConfig;
+    get state(): WindowState;
+    private restoreState;
+    get meta(): any;
+    setPosition(data: {
+        x: number;
+        y: number;
+    }): void;
+    setActive(value: boolean): void;
+    setFocus(value: boolean): void;
+    focus(): void;
+    get title(): string;
+    get windowTitle(): string;
+    get icon(): any;
+    get position(): _owdproject_core.WindowPosition | undefined;
+    get size(): {
+        width: WindowSizeValue;
+        height: WindowSizeValue;
+        minWidth: WindowSizeValue;
+        maxWidth: WindowSizeValue;
+        minHeight: WindowSizeValue;
+        maxHeight: WindowSizeValue;
+    };
+    setSize(data: {
+        width: number;
+        height: number;
+    }): void;
+    get isMinimizable(): boolean;
+    minimize(): boolean;
+    unminimize(): boolean;
+    toggleMinimize(): void;
+    get isMaximizable(): boolean;
+    get isMaximized(): boolean;
+    private parseSizeValue;
+    saveBoundsBeforeLayout(): void;
+    setLayout(layout: WindowLayout): boolean;
+    clearLayout(): boolean;
+    toggleMaximize(): boolean;
+    maximize(): boolean;
+    unmaximize(): boolean;
+    get isDestroyable(): boolean;
+    dispose(): void;
+    destroy(): boolean;
+    get isDraggable(): boolean;
+    get isResizable(): boolean;
+    setWorkspace(workspaceId: string): void;
+    startDrag(): void;
+    stopDrag(): void;
+    startResize(): void;
+    stopResize(): void;
+    setTitleOverride(value: undefined | string): void;
+    resetTitleOverride(): void;
+    setWindowTitleOverride(value: undefined | string): void;
+    resetWindowTitleOverride(): void;
+    menu: any[];
+    setMenu(menu: any[]): void;
+}
+
+declare const _default: _nuxt_schema.NuxtModule<DesktopConfig, DesktopConfig, false>;
+
+type ModuleOptions = DesktopConfig;
+declare module '@nuxt/schema' {
+    interface NuxtConfig {
+        desktop?: DesktopConfig;
+    }
+    interface NuxtOptions {
+        desktop?: DesktopConfig;
+    }
+}
+
+export { WindowController, _default as default, useDesktop, useDesktopDrag, useDesktopResize, useVueWindowManager, useWindowInstance, useWindowManager };
+export type { DesktopDragOptions, DesktopResizeOptions, ModuleOptions };

package/dist/module.json

@@ -0,0 +1,12 @@
+{
+  "name": "@owdproject/nuxt",
+  "configKey": "desktop",
+  "compatibility": {
+    "nuxt": ">=3.0.0 || >=4.0.0"
+  },
+  "version": "4.0.0-alpha.3",
+  "builder": {
+    "@nuxt/module-builder": "1.0.3",
+    "unbuild": "3.6.1"
+  }
+}