@serve.zone/interfaces 5.0.4 → 5.4.2

package/ts/data/settings.ts

@@ -0,0 +1,56 @@
+import * as plugins from '../plugins.js';
+
+/**
+ * Interface for Cloudly settings stored in EasyStore
+ * These are runtime-configurable settings that can be modified via the UI
+ */
+export interface ICloudlySettings {
+  // Cloud Provider Tokens
+  hetznerToken?: string;
+  cloudflareToken?: string;
+  
+  // AWS Credentials
+  awsAccessKey?: string;
+  awsSecretKey?: string;
+  awsRegion?: string;
+  
+  // DigitalOcean
+  digitalOceanToken?: string;
+  
+  // Azure Credentials
+  azureClientId?: string;
+  azureClientSecret?: string;
+  azureTenantId?: string;
+  azureSubscriptionId?: string;
+  
+  // Google Cloud
+  googleCloudKeyJson?: string;
+  googleCloudProjectId?: string;
+  
+  // Vultr
+  vultrApiKey?: string;
+  
+  // Linode
+  linodeToken?: string;
+  
+  // OVH
+  ovhApplicationKey?: string;
+  ovhApplicationSecret?: string;
+  ovhConsumerKey?: string;
+  
+  // Scaleway
+  scalewayAccessKey?: string;
+  scalewaySecretKey?: string;
+  scalewayOrganizationId?: string;
+  
+  // Other settings that might be added in the future
+  [key: string]: string | undefined;
+}
+
+/**
+ * Interface for masked settings (used in API responses)
+ * Shows only last 4 characters of sensitive tokens
+ */
+export type ICloudlySettingsMasked = {
+  [K in keyof ICloudlySettings]: string | undefined;
+};

package/ts/data/taskexecution.ts

@@ -0,0 +1,84 @@
+/**
+ * Task execution tracking for the task management system
+ * Tasks themselves are hard-coded using @push.rocks/taskbuffer
+ * This interface tracks execution history and outcomes
+ */
+export interface ITaskExecution {
+  id: string;
+  data: {
+    /**
+     * Name of the task being executed
+     */
+    taskName: string;
+    
+    /**
+     * Optional description of what the task does
+     */
+    taskDescription?: string;
+    
+    /**
+     * Category for grouping tasks
+     */
+    category?: 'maintenance' | 'deployment' | 'backup' | 'monitoring' | 'cleanup' | 'system' | 'security';
+    
+    /**
+     * Timestamp when the task started
+     */
+    startedAt: number;
+    
+    /**
+     * Timestamp when the task completed
+     */
+    completedAt?: number;
+    
+    /**
+     * Current status of the task execution
+     */
+    status: 'running' | 'completed' | 'failed' | 'cancelled';
+    
+    /**
+     * Duration in milliseconds
+     */
+    duration?: number;
+    
+    /**
+     * How the task was triggered
+     */
+    triggeredBy: 'schedule' | 'manual' | 'system';
+    
+    /**
+     * User ID if manually triggered
+     */
+    userId?: string;
+    
+    /**
+     * Execution logs
+     */
+    logs: Array<{
+      timestamp: number;
+      message: string;
+      severity: 'info' | 'warning' | 'error' | 'success';
+    }>;
+    
+    /**
+     * Task-specific metrics
+     */
+    metrics?: {
+      [key: string]: any;
+    };
+    
+    /**
+     * Final result/output of the task
+     */
+    result?: any;
+    
+    /**
+     * Error details if the task failed
+     */
+    error?: {
+      message: string;
+      stack?: string;
+      code?: string;
+    };
+  };
+}

package/ts/requests/baremetal.ts

@@ -0,0 +1,22 @@
+import * as plugins from '../plugins.js';
+import type { IBareMetal } from '../data/baremetal.js';
+
+export interface IRequest_Any_Cloudly_GetBaremetalServers {
+  method: 'getBaremetalServers';
+  request: {};
+  response: {
+    baremetals: IBareMetal[];
+  };
+}
+
+export interface IRequest_Any_Cloudly_ControlBaremetal {
+  method: 'controlBaremetal';
+  request: {
+    baremetalId: string;
+    action: 'powerOn' | 'powerOff' | 'reset';
+  };
+  response: {
+    success: boolean;
+    message: string;
+  };
+}

package/{ts_interfaces → ts}/requests/cluster.ts

@@ -41,6 +41,7 @@ export interface IRequest_CreateCluster extends plugins.typedrequestInterfaces.i
   request: {
     identity: userInterfaces.IIdentity;
     clusterName: string;
+    setupMode?: 'manual' | 'hetzner' | 'aws' | 'digitalocean';
   };
   response: {
     cluster: clusterInterfaces.ICluster;

package/ts/requests/deployment.ts

@@ -0,0 +1,141 @@
+import * as plugins from '../plugins.js';
+import type { IDeployment } from '../data/deployment.js';
+import type { IIdentity } from '../data/user.js';
+
+export interface IReq_Any_Cloudly_GetDeploymentById 
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Any_Cloudly_GetDeploymentById
+> {
+  method: 'getDeploymentById';
+  request: {
+    identity: IIdentity;
+    deploymentId: string;
+  };
+  response: {
+    deployment: IDeployment;
+  };
+}
+
+export interface IReq_Any_Cloudly_GetDeployments
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Any_Cloudly_GetDeployments
+> {
+  method: 'getDeployments';
+  request: {
+    identity: IIdentity;
+  };
+  response: {
+    deployments: IDeployment[];
+  };
+}
+
+export interface IReq_Any_Cloudly_GetDeploymentsByService
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Any_Cloudly_GetDeploymentsByService
+> {
+  method: 'getDeploymentsByService';
+  request: {
+    identity: IIdentity;
+    serviceId: string;
+  };
+  response: {
+    deployments: IDeployment[];
+  };
+}
+
+export interface IReq_Any_Cloudly_GetDeploymentsByNode
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Any_Cloudly_GetDeploymentsByNode
+> {
+  method: 'getDeploymentsByNode';
+  request: {
+    identity: IIdentity;
+    nodeId: string;
+  };
+  response: {
+    deployments: IDeployment[];
+  };
+}
+
+export interface IReq_Any_Cloudly_CreateDeployment
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Any_Cloudly_CreateDeployment
+> {
+  method: 'createDeployment';
+  request: {
+    identity: IIdentity;
+    deploymentData: Partial<IDeployment>;
+  };
+  response: {
+    deployment: IDeployment;
+  };
+}
+
+export interface IReq_Any_Cloudly_UpdateDeployment
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Any_Cloudly_UpdateDeployment
+> {
+  method: 'updateDeployment';
+  request: {
+    identity: IIdentity;
+    deploymentId: string;
+    deploymentData: Partial<IDeployment>;
+  };
+  response: {
+    deployment: IDeployment;
+  };
+}
+
+export interface IReq_Any_Cloudly_DeleteDeploymentById
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Any_Cloudly_DeleteDeploymentById
+> {
+  method: 'deleteDeploymentById';
+  request: {
+    identity: IIdentity;
+    deploymentId: string;
+  };
+  response: {
+    success: boolean;
+  };
+}
+
+export interface IReq_Any_Cloudly_RestartDeployment
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Any_Cloudly_RestartDeployment
+> {
+  method: 'restartDeployment';
+  request: {
+    identity: IIdentity;
+    deploymentId: string;
+  };
+  response: {
+    success: boolean;
+    deployment: IDeployment;
+  };
+}
+
+export interface IReq_Any_Cloudly_ScaleDeployment
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Any_Cloudly_ScaleDeployment
+> {
+  method: 'scaleDeployment';
+  request: {
+    identity: IIdentity;
+    deploymentId: string;
+    replicas: number;
+  };
+  response: {
+    success: boolean;
+    deployment: IDeployment;
+  };
+}

package/ts/requests/dns.ts

@@ -0,0 +1,93 @@
+import * as plugins from '../plugins.js';
+import type { IDnsEntry } from '../data/dns.js';
+import type { IIdentity } from '../data/user.js';
+
+export interface IRequest_Any_Cloudly_GetDnsEntries
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IRequest_Any_Cloudly_GetDnsEntries
+> {
+  method: 'getDnsEntries';
+  request: {
+    identity: IIdentity;
+    zone?: string; // Optional filter by zone
+  };
+  response: {
+    dnsEntries: IDnsEntry[];
+  };
+}
+
+export interface IRequest_Any_Cloudly_GetDnsEntryById
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IRequest_Any_Cloudly_GetDnsEntryById
+> {
+  method: 'getDnsEntryById';
+  request: {
+    identity: IIdentity;
+    dnsEntryId: string;
+  };
+  response: {
+    dnsEntry: IDnsEntry;
+  };
+}
+
+export interface IRequest_Any_Cloudly_CreateDnsEntry
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IRequest_Any_Cloudly_CreateDnsEntry
+> {
+  method: 'createDnsEntry';
+  request: {
+    identity: IIdentity;
+    dnsEntryData: IDnsEntry['data'];
+  };
+  response: {
+    dnsEntry: IDnsEntry;
+  };
+}
+
+export interface IRequest_Any_Cloudly_UpdateDnsEntry
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IRequest_Any_Cloudly_UpdateDnsEntry
+> {
+  method: 'updateDnsEntry';
+  request: {
+    identity: IIdentity;
+    dnsEntryId: string;
+    dnsEntryData: IDnsEntry['data'];
+  };
+  response: {
+    dnsEntry: IDnsEntry;
+  };
+}
+
+export interface IRequest_Any_Cloudly_DeleteDnsEntry
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IRequest_Any_Cloudly_DeleteDnsEntry
+> {
+  method: 'deleteDnsEntry';
+  request: {
+    identity: IIdentity;
+    dnsEntryId: string;
+  };
+  response: {
+    success: boolean;
+  };
+}
+
+export interface IRequest_Any_Cloudly_GetDnsZones
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IRequest_Any_Cloudly_GetDnsZones
+> {
+  method: 'getDnsZones';
+  request: {
+    identity: IIdentity;
+  };
+  response: {
+    zones: string[];
+  };
+}

package/ts/requests/domain.ts

@@ -0,0 +1,99 @@
+import * as plugins from '../plugins.js';
+import type { IDomain } from '../data/domain.js';
+import type { IIdentity } from '../data/user.js';
+
+export interface IRequest_Any_Cloudly_GetDomains
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IRequest_Any_Cloudly_GetDomains
+> {
+  method: 'getDomains';
+  request: {
+    identity: IIdentity;
+  };
+  response: {
+    domains: IDomain[];
+  };
+}
+
+export interface IRequest_Any_Cloudly_GetDomainById
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IRequest_Any_Cloudly_GetDomainById
+> {
+  method: 'getDomainById';
+  request: {
+    identity: IIdentity;
+    domainId: string;
+  };
+  response: {
+    domain: IDomain;
+  };
+}
+
+export interface IRequest_Any_Cloudly_CreateDomain
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IRequest_Any_Cloudly_CreateDomain
+> {
+  method: 'createDomain';
+  request: {
+    identity: IIdentity;
+    domainData: IDomain['data'];
+  };
+  response: {
+    domain: IDomain;
+  };
+}
+
+export interface IRequest_Any_Cloudly_UpdateDomain
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IRequest_Any_Cloudly_UpdateDomain
+> {
+  method: 'updateDomain';
+  request: {
+    identity: IIdentity;
+    domainId: string;
+    domainData: IDomain['data'];
+  };
+  response: {
+    domain: IDomain;
+  };
+}
+
+export interface IRequest_Any_Cloudly_DeleteDomain
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IRequest_Any_Cloudly_DeleteDomain
+> {
+  method: 'deleteDomain';
+  request: {
+    identity: IIdentity;
+    domainId: string;
+  };
+  response: {
+    success: boolean;
+  };
+}
+
+export interface IRequest_Any_Cloudly_VerifyDomain
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IRequest_Any_Cloudly_VerifyDomain
+> {
+  method: 'verifyDomain';
+  request: {
+    identity: IIdentity;
+    domainId: string;
+    verificationMethod?: 'dns' | 'http' | 'email' | 'manual';
+  };
+  response: {
+    domain: IDomain;
+    verificationResult: {
+      success: boolean;
+      message?: string;
+      details?: any;
+    };
+  };
+}

package/{ts_interfaces → ts}/requests/externalregistry.ts

@@ -50,6 +50,7 @@ export interface IReq_UpdateRegistry extends plugins.typedrequestInterfaces.impl
   method: 'updateExternalRegistry';
   request: {
     identity: userInterfaces.IIdentity;
+    registryId: string;
     registryData: data.IExternalRegistry['data'];
   };
   response: {
@@ -69,4 +70,20 @@ export interface IReq_DeleteRegistryById extends plugins.typedrequestInterfaces.
   response: {
     ok: boolean;
   };
+}
+
+export interface IReq_VerifyRegistry extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_VerifyRegistry
+> {
+  method: 'verifyExternalRegistry';
+  request: {
+    identity: userInterfaces.IIdentity;
+    registryId: string;
+  };
+  response: {
+    success: boolean;
+    message?: string;
+    registry?: data.IExternalRegistry;
+  };
 }

package/{ts_interfaces → ts}/requests/index.ts

@@ -1,40 +1,54 @@
 import * as plugins from '../plugins.js';
 
 import * as adminRequests from './admin.js';
+import * as baremetalRequests from './baremetal.js';
 import * as certificateRequests from './certificate.js';
 import * as clusterRequests from './cluster.js';
 import * as configRequests from './config.js';
+import * as deploymentRequests from './deployment.js';
+import * as dnsRequests from './dns.js';
+import * as domainRequests from './domain.js';
 import * as externalRegistryRequests from './externalregistry.js';
 import * as identityRequests from './identity.js';
 import * as imageRequests from './image.js';
 import * as informRequests from './inform.js';
 import * as logRequests from './log.js';
 import * as networkRequests from './network.js';
+import * as nodeRequests from './node.js';
 import * as routingRequests from './routing.js';
 import * as secretBundleRequests from './secretbundle.js';
 import * as secretGroupRequests from './secretgroup.js'; 
 import * as serverRequests from './server.js';
 import * as serviceRequests from './service.js';
+import * as settingsRequests from './settings.js';
 import * as statusRequests from './status.js';
+import * as taskRequests from './task.js';
 import * as versionRequests from './version.js';
 
 export {
   adminRequests as admin,
+  baremetalRequests as baremetal,
   certificateRequests as certificate,
   clusterRequests as cluster,
   configRequests as config,
+  deploymentRequests as deployment,
+  dnsRequests as dns,
+  domainRequests as domain,
   externalRegistryRequests as externalRegistry,
   identityRequests as identity,
   imageRequests as image,
   informRequests as inform,
   logRequests as log,
   networkRequests as network,
+  nodeRequests as node,
   routingRequests as routing,
   secretBundleRequests as secretbundle,
   secretGroupRequests as secretgroup,
   serverRequests as server,
   serviceRequests as service,
+  settingsRequests as settings,
   statusRequests as status,
+  taskRequests as task,
   versionRequests as version,
 };
 

package/ts/requests/node.ts

@@ -0,0 +1,33 @@
+import * as plugins from '../plugins.js';
+import type { IClusterNode } from '../data/clusternode.js';
+import type { IDeployment } from '../data/deployment.js';
+
+export interface IRequest_Any_Cloudly_GetNodeConfig {
+  method: 'getNodeConfig';
+  request: {
+    nodeId: string;
+  };
+  response: {
+    configData: IClusterNode;
+  };
+}
+
+export interface IRequest_Any_Cloudly_GetNodesByCluster {
+  method: 'getNodesByCluster';
+  request: {
+    clusterId: string;
+  };
+  response: {
+    nodes: IClusterNode[];
+  };
+}
+
+export interface IRequest_Any_Cloudly_GetNodeDeployments {
+  method: 'getNodeDeployments';
+  request: {
+    nodeId: string;
+  };
+  response: {
+    deployments: IDeployment[];
+  };
+}

package/ts/requests/settings.ts

@@ -0,0 +1,59 @@
+import * as plugins from '../plugins.js';
+import type { ICloudlySettings, ICloudlySettingsMasked } from '../data/settings.js';
+
+// Get Settings
+export interface IRequest_GetSettings extends plugins.typedrequestInterfaces.ITypedRequest {
+  method: 'getSettings';
+  request: {};
+  response: {
+    settings: ICloudlySettingsMasked;
+  };
+}
+
+// Update Settings
+export interface IRequest_UpdateSettings extends plugins.typedrequestInterfaces.ITypedRequest {
+  method: 'updateSettings';
+  request: {
+    updates: Partial<ICloudlySettings>;
+  };
+  response: {
+    success: boolean;
+    message: string;
+  };
+}
+
+// Clear Specific Setting
+export interface IRequest_ClearSetting extends plugins.typedrequestInterfaces.ITypedRequest {
+  method: 'clearSetting';
+  request: {
+    key: keyof ICloudlySettings;
+  };
+  response: {
+    success: boolean;
+    message: string;
+  };
+}
+
+// Test Provider Connection
+export interface IRequest_TestProviderConnection extends plugins.typedrequestInterfaces.ITypedRequest {
+  method: 'testProviderConnection';
+  request: {
+    provider: 'hetzner' | 'cloudflare' | 'aws' | 'digitalocean' | 'azure' | 'google' | 'vultr' | 'linode' | 'ovh' | 'scaleway';
+  };
+  response: {
+    success: boolean;
+    message: string;
+    connectionValid: boolean;
+  };
+}
+
+// Get Single Setting (for internal use, not exposed to frontend)
+export interface IRequest_GetSetting extends plugins.typedrequestInterfaces.ITypedRequest {
+  method: 'getSetting';
+  request: {
+    key: keyof ICloudlySettings;
+  };
+  response: {
+    value: string | undefined;
+  };
+}