Merge pull request #80 from eshtek/dev

dev -> main

Author: garrettjoecox

eshtek/admin.types.ts

@@ -0,0 +1,98 @@
+/**
+ * Admin API Types and Interfaces
+ */
+
+/**
+ * Response from the catalog status endpoint
+ */
+export interface CatalogStatusResponse {
+    totalApps: number;
+    totalNonDeprecated: number;
+    totalWithScripts: number;
+    totalWithScriptsNonDeprecated: number;
+    totalDeprecated: number;
+    lastSync: Date | null;
+}
+
+/**
+ * Individual app in the catalog
+ */
+export interface CatalogApp {
+    id: number;
+    name: string;
+    train: string | null;
+    version: string | null;
+    appVersion: string | null;
+    title: string | null;
+    description: string | null;
+    home: string | null;
+    iconUrl: string | null;
+    screenshots: string[];
+    sources: string[];
+    categories: string[];
+    keywords: string[];
+    maintainers: any[];
+    supported: boolean;
+    deprecated: boolean;
+    installScript: string | null;
+    requirements: any;
+    compatibility: string | null;
+    lastCatalogSync: Date | null;
+    metadata: any;
+    // Event statistics (detailed)
+    installsDiscovered?: number;
+    installsCompleted?: number;
+    installsFailed?: number;
+    uninstallsCompleted?: number;
+    uninstallsFailed?: number;
+    upgradesCompleted?: number;
+    upgradesFailed?: number;
+    updatesCompleted?: number;
+    updatesFailed?: number;
+}
+
+/**
+ * Response from the catalog data endpoint
+ */
+export interface AppsCatalogResponse {
+    apps: CatalogApp[];
+    totalApps: number;
+    totalWithScripts: number;
+    totalDeprecated: number;
+    lastSync: Date | null;
+}
+
+/**
+ * Drive data with event statistics
+ */
+export interface DriveData {
+    id: number;
+    manufacturer: string;
+    model: string;
+    name: string | null;
+    type: string | null;
+    size: number | null;
+    smr: boolean;
+    notes: string | null;
+    isUserDiscovered: boolean;
+    createdAt: Date;
+    updatedAt: Date;
+    // Event statistics
+    utilized: number;
+    replaced: number;
+    removed: number;
+    failed: number;
+    discovered: number;
+}
+
+/**
+ * Response from the drives data endpoint
+ */
+export interface DrivesResponse {
+    drives: DriveData[];
+    totalDrives: number;
+    totalSMR: number;
+    totalUtilized: number;
+    totalFailed: number;
+    totalRemoved: number;
+}

eshtek/apps-schema.ts

@@ -59,8 +59,28 @@ export interface AppRequirementsCheck {
     };
 }
 
-export interface AppListing extends AvailableApp {
-    hexos: boolean;
+export interface AppMaintainer {
+    name: string;
+    email: string;
+}
+
+export interface AppListing {
+    appId: string;
+    name: string;
+    train: "stable" | "community";
+    version: string;
+    appVersion: string;
+    description: string;
+    icon: string;
+    categories: string[];
+    keywords: string[];
+    maintainers: AppMaintainer[];
+    screenshots: string[];
+    sources: string[];
+    homepage: string;
+    recommended: boolean;
+    supported: boolean;
+    fresh: boolean;
     installScript?: string;
     requirements?: AppRequirements;
 }
@@ -69,7 +89,9 @@ export interface AppInfo extends AppBasics {
     status: AppState;
     url_webui: string;
     upgradeAvailable: boolean;
+    updatedScriptAvailable: boolean;
     latestVersion: string;
+    recommended: boolean;
 }
 export interface AppInfoDetailed extends AppInfo {
     data: number[][];
@@ -120,6 +142,7 @@ export interface InstallationQuestion {
 
 interface AppsInstallScriptV1 {
     version: 1;
+    requirements?: AppRequirements;
     ensure_directories_exists?: Array<string | { path: string; network_share?: boolean; posix?: boolean }>;
     ensure_permissions_exists?: Array<{
         path: string;
@@ -132,6 +155,7 @@ interface AppsInstallScriptV1 {
 
 interface AppsInstallScriptV2 {
     version: 2;
+    requirements?: AppRequirements;
     installation_questions?: InstallationQuestion[];
     ensure_directories_exists?: Array<string | { path: string; network_share?: boolean; posix?: boolean }>;
     ensure_permissions_exists?: Array<{
@@ -143,7 +167,22 @@ interface AppsInstallScriptV2 {
     app_values: Record<string, ChartFormValue>;
 }
 
-export type AppsInstallScript = AppsInstallScriptV1 | AppsInstallScriptV2;
+interface AppsInstallScriptV3 extends Omit<AppsInstallScriptV2, 'version' | 'requirements'> {
+    version: 3;
+    script: {
+        version: string;
+        updateCompatibility?: string;
+        changeLog?: string;
+    };
+    requirements: AppRequirements;  // Required in V3
+}
+
+export type AppsInstallScript = AppsInstallScriptV1 | AppsInstallScriptV2 | AppsInstallScriptV3;
+
+export interface AppConfiguration {
+    installScript?: AppsInstallScript | null;
+    questionResponses?: Record<string, string | number | boolean>;
+}
 
 export interface InstallScriptCuration {
     name: string;

eshtek/apps.ts

@@ -505,3 +505,16 @@ export function getStepSize(range: number, steps: number = 10, acceptableSteps:
         return Math.abs(curr - rawStep) < Math.abs(prev - rawStep) ? curr : prev;
     });
 }
+
+import type { HexTaskType } from './tasks';
+import type { EventState, TaskEventName } from './events';
+
+/**
+ * Generates a task event name from a task type and event state.
+ * @param {HexTaskType} taskType - The type of the task.
+ * @param {EventState} state - The state of the event (started, completed, failed).
+ * @returns {TaskEventName} - Returns the generated event name (e.g., 'app_install_started').
+ */
+export function getTaskEventName(taskType: HexTaskType, state: EventState): TaskEventName {
+  return `${taskType.toLowerCase()}_${state}` as TaskEventName;
+}