@edenapp/types 0.1.0

package/AppManifest.d.ts

@@ -0,0 +1,128 @@
+/**
+ * Window Mode Configuration
+ *
+ * Defines how an app's window can be displayed
+ */
+export type WindowMode = "floating" | "tiled" | "both";
+
+export interface WindowInjectionOptions {
+  /** Inject the Eden design system CSS into the view (default: true) */
+  css?: boolean;
+
+  /** Inject the Eden app frame with title bar controls (default: true) */
+  appFrame?: boolean;
+}
+
+export interface WindowConfig {
+  /** Window display modes supported by the app */
+  mode: WindowMode;
+
+  /** Default window size for floating mode */
+  defaultSize?: {
+    width: number;
+    height: number;
+  };
+
+  /** Default window position for floating mode (if not specified, will be centered) */
+  defaultPosition?: {
+    x: number;
+    y: number;
+  };
+
+  /** Minimum window size */
+  minSize?: {
+    width: number;
+    height: number;
+  };
+
+  /** Maximum window size */
+  maxSize?: {
+    width: number;
+    height: number;
+  };
+
+  /** Whether the window can be resized (default: true for floating, false for tiled) */
+  resizable?: boolean;
+
+  /** Whether the window can be moved (default: true for floating, false for tiled) */
+  movable?: boolean;
+
+  /** Whether to show the title in the title bar (default: true) */
+  showTitle?: boolean;
+
+  /** Controls which Eden runtime helpers are injected into the app */
+  injections?: WindowInjectionOptions;
+}
+
+/**
+ * App Manifest Interface
+ *
+ * Defines the structure of an Eden app package.
+ * Each app must include a manifest.json file with this structure.
+ */
+export interface AppManifest {
+  /** Unique identifier for the app (e.g., "com.example.myapp") */
+  id: string;
+
+  /** Human-readable name */
+  name: string;
+
+  /** Version string (semver recommended) */
+  version: string;
+
+  /** App description */
+  description?: string;
+
+  /** App author information */
+  author?: string;
+
+  /** Entry point for the backend worker thread */
+  backend?: {
+    /** Path to the backend entry file (relative to app root) */
+    entry: string;
+
+    /** Worker thread options */
+    options?: {
+      /** Resource limits for the worker */
+      resourceLimits?: {
+        maxOldGenerationSizeMb?: number;
+        maxYoungGenerationSizeMb?: number;
+        codeRangeSizeMb?: number;
+      };
+    };
+  };
+
+  /** Frontend configuration */
+  frontend: {
+    /** Path to the frontend HTML entry file */
+    entry: string;
+
+    /** WebContentsView options */
+    options?: {
+      /** Enable Node.js integration in the view (default: false) */
+      nodeIntegration?: boolean;
+
+      /** Enable context isolation (default: true) */
+      contextIsolation?: boolean;
+
+      /** Preload script path (relative to app root) */
+      preload?: string;
+    };
+  };
+
+  /** Window configuration */
+  window?: WindowConfig;
+
+  /** App icon path (relative to app root) */
+  icon?: string;
+
+  /** Build configuration (for prebuilt apps) */
+  build?: {
+    /** Command to build the app (e.g., "npm run build") */
+    command: string;
+  };
+
+  /** Internal flag indicating if this is a prebuilt system app */
+  isPrebuilt?: boolean;
+}
+

package/EdenConfig.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Tiling Configuration
+ *
+ * Defines how the workspace should be divided for apps
+ */
+export type TilingMode = "none" | "horizontal" | "vertical" | "grid";
+
+export interface TilingConfig {
+  /** Tiling mode */
+  mode: TilingMode;
+
+  /** Number of columns (for grid mode) */
+  columns?: number;
+
+  /** Number of rows (for grid mode) */
+  rows?: number;
+
+  /** Gap between tiles in pixels */
+  gap?: number;
+
+  /** Padding around the workspace in pixels */
+  padding?: number;
+}
+
+export interface EdenConfig {
+  appsDirectory?: string;
+  userDirectory?: string;
+  window?: {
+    width?: number;
+    height?: number;
+    title?: string;
+    backgroundColor?: string;
+  };
+  tiling?: TilingConfig;
+  development?: boolean;
+}

package/README.md

@@ -0,0 +1,30 @@
+# @edenapp/types
+
+TypeScript type definitions for the Eden platform.
+
+## Installation
+
+For Eden app development:
+
+```bash
+npm install -D @edenapp/types
+```
+
+## Usage
+
+Import types in your Eden app:
+
+```typescript
+// Use Eden API in your app's frontend
+const files = await window.edenAPI.shellCommand('fs/readdir', {
+  path: '/home/user/documents'
+});
+```
+
+## Documentation
+
+For complete Eden platform documentation, visit the main [Eden repository](https://github.com/b0czek/eden).
+
+## License
+
+MIT

package/commands.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Command Type Definitions
+ *
+ * Type-safe command definitions for the Eden IPC system.
+ * Commands are organized by namespace (e.g., "app", "view").
+ *
+ * NOTE: The actual command interfaces are auto-generated from @EdenHandler decorators.
+ * See commands.generated.ts (generated by scripts/generate-commands.ts)
+ */
+
+/**
+ * Re-export auto-generated command interfaces and CommandMap
+ * These are generated from @EdenHandler decorators at build time
+ */
+export * from "./commands.generated";
+
+import { CommandMap } from "./commands.generated";
+
+/**
+ * Type-safe command name
+ */
+export type CommandName = keyof CommandMap;
+
+/**
+ * Get command arguments type
+ */
+export type CommandArgs<T extends CommandName> = CommandMap[T]["args"];
+
+/**
+ * Get command result type
+ */
+export type CommandResult<T extends CommandName> = CommandMap[T]["response"];

package/commands.generated.d.ts

@@ -0,0 +1,317 @@
+/**
+ * AUTO-GENERATED FILE - DO NOT EDIT
+ * 
+ * This file is automatically generated by scripts/generate-commands.ts
+ * Run 'npm run codegen' to regenerate.
+ */
+
+/**
+ * SystemCommands - Commands for the "system" namespace
+ */
+export interface SystemCommands {
+  /**
+   * Get system information including platform, versions, and running apps.
+   */
+  "system/info": {
+    args: Record<string, never>;
+    response: SystemInfo;
+  };
+}
+
+/**
+ * FsCommands - Commands for the "fs" namespace
+ */
+export interface FsCommands {
+  /**
+   * Read the contents of a file.
+   */
+  "fs/read": {
+    args: {
+    path: string;
+    encoding?: BufferEncoding;
+  };
+    response: string;
+  };
+  /**
+   * Write content to a file, creating directories if needed.
+   */
+  "fs/write": {
+    args: {
+    path: string;
+    content: string;
+    encoding?: BufferEncoding;
+  };
+    response: void;
+  };
+  /**
+   * Check if a file or directory exists.
+   */
+  "fs/exists": {
+    args: { path: string };
+    response: boolean;
+  };
+  /**
+   * Create a directory and any necessary parent directories.
+   */
+  "fs/mkdir": {
+    args: { path: string };
+    response: void;
+  };
+  /**
+   * List contents of a directory.
+   */
+  "fs/readdir": {
+    args: { path: string };
+    response: string[];
+  };
+  /**
+   * Get file or directory statistics.
+   */
+  "fs/stat": {
+    args: { path: string };
+    response: {
+    isFile: boolean;
+    isDirectory: boolean;
+    size: number;
+    mtime: Date;
+  };
+  };
+  /**
+   * Search for files and directories using glob patterns.
+   */
+  "fs/search": {
+    args: {
+    path: string;
+    pattern: string;
+    limit?: number;
+  };
+    response: Array<{
+      name: string;
+      path: string;
+      type: "file" | "folder";
+    }>;
+  };
+  /**
+   * Delete a file or directory.
+   * For directories, removes recursively.
+   */
+  "fs/delete": {
+    args: { path: string };
+    response: void;
+  };
+}
+
+/**
+ * PackageCommands - Commands for the "package" namespace
+ */
+export interface PackageCommands {
+  /**
+   * Install an application from a local path.
+   */
+  "package/install": {
+    args: { sourcePath: string };
+    response: AppManifest;
+  };
+  /**
+   * Uninstall an application by its ID.
+   */
+  "package/uninstall": {
+    args: { appId: string };
+    response: boolean;
+  };
+  /**
+   * List all installed applications.
+   */
+  "package/list-installed": {
+    args: Record<string, never>;
+    response: AppManifest[];
+  };
+  /**
+   * Toggle hot reload for an app
+   */
+  "package/toggle-hot-reload": {
+    args: { appId: string };
+    response: { enabled: boolean };
+  };
+  /**
+   * Check if hot reload is enabled for an app
+   */
+  "package/is-hot-reload-enabled": {
+    args: { appId: string };
+    response: { enabled: boolean };
+  };
+}
+
+/**
+ * ProcessCommands - Commands for the "process" namespace
+ */
+export interface ProcessCommands {
+  /**
+   * Launch an application instance.
+   */
+  "process/launch": {
+    args: {
+    appId: string;
+    bounds?: ViewBounds;
+  };
+    response: LaunchResult;
+  };
+  /**
+   * Stop a running application instance.
+   */
+  "process/stop": {
+    args: { appId: string };
+    response: { success: boolean };
+  };
+  /**
+   * List all running application processes.
+   */
+  "process/list": {
+    args: Record<string, never>;
+    response: AppStatus;
+  };
+}
+
+/**
+ * ViewCommands - Commands for the "view" namespace
+ */
+export interface ViewCommands {
+  /**
+   * Update the bounds (position and size) of a specific view.
+   */
+  "view/update-view-bounds": {
+    args: {
+    appId: string;
+    bounds: ViewBounds;
+  };
+    response: { success: boolean };
+  };
+  /**
+   * Show or hide a specific view.
+   */
+  "view/set-view-visibility": {
+    args: {
+    appId: string;
+    visible: boolean;
+  };
+    response: { success: boolean };
+  };
+  /**
+   * Bring an application's view to the front and focus it.
+   */
+  "view/focus-app": {
+    args: { appId: string };
+    response: { success: boolean };
+  };
+  /**
+   * Update the available workspace bounds (e.g. after taskbar resize).
+   */
+  "view/update-global-bounds": {
+    args: {
+    bounds: ViewBounds;
+    windowSize: WindowSize;
+  };
+    response: { success: boolean };
+  };
+  /**
+   * Toggle between floating and tiled window modes.
+   */
+  "view/toggle-view-mode": {
+    args: {
+    appId: string;
+    mode?: "floating" | "tiled";
+  };
+    response: { success: boolean };
+  };
+  /**
+   * Start dragging a window.
+   */
+  "view/start-drag": {
+    args: {
+    appId: string;
+    startX: number;
+    startY: number;
+  };
+    response: { success: boolean };
+  };
+  /**
+   * End the current drag operation.
+   */
+  "view/end-drag": {
+    args: { appId: string };
+    response: { success: boolean };
+  };
+  /**
+   * Handle global mouse up event to stop any active drag/resize operations.
+   */
+  "view/global-mouseup": {
+    args: Record<string, never>;
+    response: { success: boolean };
+  };
+  /**
+   * Start resizing a window.
+   */
+  "view/start-resize": {
+    args: {
+    appId: string;
+    startX: number;
+    startY: number;
+  };
+    response: { success: boolean };
+  };
+  /**
+   * End the current resize operation.
+   */
+  "view/end-resize": {
+    args: {
+    appId: string;
+  };
+    response: { success: boolean };
+  };
+  /**
+   * Get the current dimensions of the main window.
+   */
+  "view/window-size": {
+    args: Record<string, never>;
+    response: WindowSize;
+  };
+}
+
+/**
+ * Global command map - merge all command namespaces
+ */
+export interface CommandMap extends SystemCommands, FsCommands, PackageCommands, ProcessCommands, ViewCommands {}
+
+/**
+ * Array of all available command names
+ */
+export const COMMAND_NAMES = [
+  "system/info",
+  "fs/read",
+  "fs/write",
+  "fs/exists",
+  "fs/mkdir",
+  "fs/readdir",
+  "fs/stat",
+  "fs/search",
+  "fs/delete",
+  "package/install",
+  "package/uninstall",
+  "package/list-installed",
+  "package/toggle-hot-reload",
+  "package/is-hot-reload-enabled",
+  "process/launch",
+  "process/stop",
+  "process/list",
+  "view/update-view-bounds",
+  "view/set-view-visibility",
+  "view/focus-app",
+  "view/update-global-bounds",
+  "view/toggle-view-mode",
+  "view/start-drag",
+  "view/end-drag",
+  "view/global-mouseup",
+  "view/start-resize",
+  "view/end-resize",
+  "view/window-size"
+] as const;

package/events.d.ts

@@ -0,0 +1,18 @@
+/**
+ * AppEvents - Events sent from backend to renderer
+ * 
+ * All events are sent via the unified 'shell-message' channel.
+ * Views must subscribe to specific events to receive them.
+ * 
+ * This file re-exports auto-generated event types.
+ * Event definitions are automatically generated from @EdenNamespace decorators.
+ * Run 'npm run codegen' to regenerate.
+ */
+
+export * from "./events.generated";
+
+/**
+ * Utility types for working with AppEvents
+ */
+export type EventName = (typeof import("./events.generated").APP_EVENT_NAMES)[number];
+export type EventData<T extends EventName> = import("./events.generated").AppEvents[T];

package/events.generated.d.ts

@@ -0,0 +1,51 @@
+/**
+ * AUTO-GENERATED FILE - DO NOT EDIT
+ * 
+ * This file is automatically generated by scripts/generate-commands.ts
+ * Run 'npm run codegen' to regenerate.
+ */
+
+/**
+ * PackageEvents - Events for the "package" namespace
+ */
+export interface PackageEvents {
+  "package/installed": { manifest: AppManifest };
+  "package/uninstalled": { appId: string };
+}
+
+/**
+ * ProcessEvents - Events for the "process" namespace
+ */
+export interface ProcessEvents {
+  "process/launched": { instance: AppInstance };
+  "process/stopped": { appId: string };
+  "process/error": { appId: string; error: any };
+  "process/exited": { appId: string; code: number };
+}
+
+/**
+ * ViewEvents - Events for the "view" namespace
+ */
+export interface ViewEvents {
+  "view/bounds-updated": ViewBounds;
+  "view/global-bounds-changed": { workspaceBounds: ViewBounds; windowSize: WindowSize };
+}
+
+/**
+ * Global event map - merge all event namespaces
+ */
+export interface AppEvents extends PackageEvents, ProcessEvents, ViewEvents {}
+
+/**
+ * Array of all available event names
+ */
+export const APP_EVENT_NAMES = [
+  "package/installed",
+  "package/uninstalled",
+  "process/launched",
+  "process/stopped",
+  "process/error",
+  "process/exited",
+  "view/bounds-updated",
+  "view/global-bounds-changed"
+] as const;

package/global.d.ts

@@ -0,0 +1,55 @@
+// Ambient declarations for renderer globals
+
+import type { CommandName, CommandArgs, CommandResult } from "./commands";
+import type { EventName, EventData } from "./events";
+
+interface EdenAPI {
+  /**
+   * Execute a shell command with type-safe arguments
+   * @param command - The command name (e.g., "process/launch")
+   * @param args - Type-safe arguments for the command
+   * @returns Promise with the command result
+   * 
+   * @example
+   * ```typescript
+   * await edenAPI.shellCommand("process/launch", { 
+   *   appId: "my-app",
+   *   bounds: { x: 0, y: 0, width: 800, height: 600 }
+   * });
+   * ```
+   */
+  shellCommand<T extends CommandName>(
+    command: T,
+    args: CommandArgs<T>
+  ): Promise<CommandResult<T>>;
+  
+  /**
+   * Subscribe to a system event
+   * @param event - The event name
+   * @param callback - Callback function receiving typed event data
+   */
+  subscribe<T extends EventName>(
+    event: T,
+    callback: (data: EventData<T>) => void
+  ): Promise<void>;
+
+  /**
+   * Unsubscribe from a system event
+   */
+  unsubscribe<T extends EventName>(
+    event: T,
+    callback: (data: EventData<T>) => void
+  ): void;
+
+  /**
+   * Check if an event is supported by the system
+   */
+  isEventSupported(event: string): Promise<boolean>;
+}
+
+interface Window {
+  /**
+   * Eden API instance available only in renderer processes
+   */
+  edenAPI?: EdenAPI;
+}

package/index.d.ts

@@ -0,0 +1,103 @@
+import { AppManifest } from "./AppManifest";
+
+export * from "./EdenConfig";
+
+export * from "./AppManifest";
+
+/**
+ * App Instance Interface
+ *
+ * Represents a running app instance in the Eden environment
+ */
+export interface AppInstance {
+  /** App manifest */
+  manifest: AppManifest;
+
+  /** Unique instance ID */
+  instanceId: string;
+
+  /** Installation path on disk */
+  installPath: string;
+
+  /** WebContentsView ID */
+  viewId: number;
+
+  /** Current state */
+  state: "starting" | "running" | "paused" | "stopped" | "error";
+
+  /** Installation timestamp */
+  installedAt: Date;
+
+  /** Last launched timestamp */
+  lastLaunched?: Date;
+}
+
+/**
+ * IPC Message Interface
+ *
+ * Standard message format for IPC communication
+ */
+export interface IPCMessage {
+  /** Message type/action */
+  type: string;
+
+  /** Source app ID (or 'system' for system messages) */
+  source: string;
+
+  /** Target app ID (or 'system' for system messages) */
+  target: string;
+
+  /** Message payload */
+  payload: any;
+
+  /** Unique message ID for tracking responses */
+  messageId: string;
+
+  /** If this is a response to another message, the original message ID */
+  replyTo?: string;
+
+  /** Timestamp */
+  timestamp: number;
+}
+
+export interface ViewBounds {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+}
+
+// Export new command types
+export type {
+  CommandName,
+  CommandArgs,
+  CommandResult,
+  CommandMap,
+} from "./commands";
+
+// Export event types
+export * from "./events";
+
+export interface SystemInfo {
+  platform: string;
+  arch: string;
+  nodeVersion: string;
+  electronVersion: string;
+  runningApps: string[];
+}
+
+export interface WindowSize {
+  width: number;
+  height: number;
+}
+
+export interface LaunchResult {
+  success: boolean;
+  instanceId: string;
+  appId: string;
+}
+
+export interface AppStatus {
+  installed: AppManifest[];
+  running: AppInstance[];
+}

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@edenapp/types",
+  "version": "0.1.0",
+  "description": "TypeScript type definitions for the Eden platform",
+  "types": "index.d.ts",
+  "author": "Dariusz Majnert",
+  "license": "MIT",
+  "files": [
+    "*.d.ts",
+    "README.md"
+  ],
+  "keywords": [
+    "eden",
+    "types",
+    "typescript",
+    "definitions"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/b0czek/eden.git",
+    "directory": "src/types"
+  }
+}