@serve.zone/interfaces 5.3.0 → 5.4.3

package/readme.md

@@ -1,391 +1,29 @@
-# @serve.zone/interfaces 📋
+# @serve.zone/interfaces
 
-**TypeScript interfaces for the Cloudly ecosystem.** Type-safe contracts for multi-cloud infrastructure management.
+Shared TypeScript interfaces and TypedRequest contracts for the serve.zone ecosystem.
 
-## 🎯 What is @serve.zone/interfaces?
+This package contains the public contracts consumed by Cloudly, Spark, Coreflow, Coretraffic, Platformclient, and external integrations. It is intentionally dependency-light and should not contain runtime implementation code.
 
-This package provides the complete set of TypeScript interfaces that power the Cloudly platform. It ensures type safety and consistency across all components - from API requests to data models, from service definitions to infrastructure configurations.
-
-## ✨ Features
-
-- **🔒 Type Safety** - Comprehensive TypeScript interfaces for all Cloudly operations
-- **📦 Modular Structure** - Organized by domain for easy navigation
-- **🔄 Version Compatibility** - Interfaces versioned with the platform
-- **📚 Well Documented** - Each interface includes JSDoc comments
-- **🎭 Multi-Purpose** - Used by API clients, CLI tools, and web interfaces
-- **✅ Validation Ready** - Compatible with runtime type checking libraries
-
-## 🚀 Installation
+## Install
 
 ```bash
 pnpm add @serve.zone/interfaces
 ```
 
-## 🏗️ Interface Categories
-
-### 📡 Request/Response Interfaces
-
-Typed contracts for API communication:
-
-```typescript
-import { 
-  IRequest_GetAllImages,
-  IRequest_CreateCluster,
-  IRequest_DeployService 
-} from '@serve.zone/interfaces';
-
-// Type-safe request
-const request: IRequest_GetAllImages['request'] = {
-  identity: userIdentity,
-  filters: {
-    tag: 'production'
-  }
-};
-
-// Type-safe response
-const response: IRequest_GetAllImages['response'] = {
-  images: [...]
-};
-```
-
-### 📦 Data Models
-
-Core data structures for Cloudly entities:
-
-```typescript
-import { 
-  ICluster, 
-  IService, 
-  IImage, 
-  ISecret,
-  IServer 
-} from '@serve.zone/interfaces';
-
-// Define a service
-const service: IService = {
-  id: 'service-123',
-  data: {
-    name: 'api-service',
-    imageId: 'image-456',
-    imageVersion: '2.0.0',
-    environment: {
-      NODE_ENV: 'production'
-    },
-    scaleFactor: 3,
-    balancingStrategy: 'round-robin',
-    ports: {
-      web: 80,
-      metrics: 9090
-    },
-    domains: [
-      { name: 'api.example.com' }
-    ],
-    deploymentIds: [],
-    deploymentDirectiveIds: []
-  }
-};
-```
-
-### 🔐 Authentication & Identity
-
-Identity management interfaces:
-
-```typescript
-import { 
-  IIdentity, 
-  IServiceToken,
-  IPermission 
-} from '@serve.zone/interfaces';
-
-const identity: IIdentity = {
-  id: 'user-789',
-  name: 'service-account',
-  type: 'service',
-  permissions: ['cluster:read', 'service:write'],
-  tokenHash: 'hashed-token',
-  metadata: {
-    createdAt: new Date(),
-    lastAccess: new Date()
-  }
-};
-```
-
-### 🌐 Network Configuration
-
-Networking and routing interfaces:
-
-```typescript
-import { 
-  IReverseProxyConfig,
-  IDomainConfig,
-  ILoadBalancerConfig 
-} from '@serve.zone/interfaces';
-
-const proxyConfig: IReverseProxyConfig = {
-  domain: 'app.example.com',
-  path: '/api',
-  serviceAddress: 'http://api-service:3000',
-  ssl: true,
-  headers: {
-    'X-Real-IP': '$remote_addr'
-  }
-};
-```
-
-### 📊 Monitoring & Metrics
-
-Observability interfaces:
+## Usage
 
 ```typescript
-import { 
-  IServerMetrics,
-  IServiceMetrics,
-  IClusterHealth 
-} from '@serve.zone/interfaces';
-
-const metrics: IServerMetrics = {
-  serverId: 'server-001',
-  cpuUsageInPercent: 65,
-  memoryUsageinMB: 3072,
-  memoryAvailableInMB: 8192,
-  diskUsageInPercent: 40,
-  networkInMbps: 100,
-  networkOutMbps: 150,
-  containerCount: 12,
-  containerMetrics: [...]
-};
+import { data, requests, platformservice } from '@serve.zone/interfaces';
 ```
 
-### 🔒 Secret Management
-
-Security and credential interfaces:
+## Development
 
-```typescript
-import { 
-  ISecretGroup,
-  ISecretBundle,
-  IEncryptedData 
-} from '@serve.zone/interfaces';
-
-const secretGroup: ISecretGroup = {
-  id: 'secrets-123',
-  name: 'database-credentials',
-  secrets: [
-    {
-      key: 'DB_HOST',
-      value: 'encrypted-value',
-      encrypted: true
-    },
-    {
-      key: 'DB_PASSWORD',
-      value: 'encrypted-value',
-      encrypted: true
-    }
-  ],
-  metadata: {
-    environment: 'production',
-    service: 'api'
-  }
-};
-```
-
-## 📚 Common Usage Patterns
-
-### Creating Type-Safe API Clients
-
-```typescript
-import { 
-  IRequest_CreateService,
-  IService 
-} from '@serve.zone/interfaces';
-
-class ServiceClient {
-  async createService(
-    serviceData: IService['data']
-  ): Promise<IService> {
-    const request: IRequest_CreateService['request'] = {
-      identity: this.identity,
-      serviceData
-    };
-    
-    const response = await this.client.send<IRequest_CreateService>(
-      'createService',
-      request
-    );
-    
-    return response.service;
-  }
-}
-```
-
-### Validating Incoming Data
-
-```typescript
-import { ICluster } from '@serve.zone/interfaces';
-import { validateType } from 'your-validation-library';
-
-function validateClusterData(data: unknown): ICluster {
-  if (!validateType<ICluster>(data)) {
-    throw new Error('Invalid cluster data');
-  }
-  return data;
-}
-```
-
-### Building Configuration Objects
-
-```typescript
-import { 
-  ICloudlyConfig,
-  IMongoDescriptor 
-} from '@serve.zone/interfaces';
-
-const config: ICloudlyConfig = {
-  cfToken: process.env.CF_TOKEN!,
-  hetznerToken: process.env.HETZNER_TOKEN!,
-  environment: 'production',
-  letsEncryptEmail: 'certs@example.com',
-  publicUrl: 'cloudly.example.com',
-  publicPort: 443,
-  mongoDescriptor: {
-    mongoDbUrl: process.env.MONGO_URL!,
-    mongoDbName: 'cloudly',
-    mongoDbUser: process.env.MONGO_USER!,
-    mongoDbPass: process.env.MONGO_PASS!
-  }
-};
-```
-
-## 🎯 Advanced Features
-
-### Generic Request Handler
-
-```typescript
-import { ITypedRequest } from '@serve.zone/interfaces';
-
-class RequestHandler {
-  async handle<T extends ITypedRequest>(
-    request: T['request']
-  ): Promise<T['response']> {
-    // Type-safe request handling
-    return this.processRequest(request);
-  }
-}
-```
-
-### Discriminated Unions
-
-```typescript
-import { IDeploymentStatus } from '@serve.zone/interfaces';
-
-function handleStatus(status: IDeploymentStatus) {
-  switch (status.type) {
-    case 'pending':
-      console.log('Deployment pending...');
-      break;
-    case 'running':
-      console.log(`Running on ${status.serverId}`);
-      break;
-    case 'failed':
-      console.log(`Failed: ${status.error}`);
-      break;
-  }
-}
-```
-
-### Extending Interfaces
-
-```typescript
-import { IService } from '@serve.zone/interfaces';
-
-interface IExtendedService extends IService {
-  customMetadata: {
-    team: string;
-    costCenter: string;
-    sla: 'standard' | 'premium';
-  };
-}
-```
-
-## 🔄 Version Compatibility
-
-| @serve.zone/interfaces | @serve.zone/cloudly | @serve.zone/api | @serve.zone/cli |
-|------------------------|---------------------|-----------------|-----------------|
-| 5.x                    | 5.x                 | 5.x             | 5.x             |
-| 4.x                    | 4.x                 | 4.x             | 4.x             |
-| 3.x                    | 3.x                 | 3.x             | 3.x             |
-
-## 📖 Interface Documentation
-
-All interfaces include comprehensive JSDoc comments:
-
-```typescript
-/**
- * Represents a cluster configuration
- * @interface ICluster
- */
-export interface ICluster {
-  /**
-   * Unique identifier for the cluster
-   * @type {string}
-   */
-  id: string;
-  
-  /**
-   * Cluster configuration data
-   * @type {IClusterData}
-   */
-  data: IClusterData;
-}
-```
-
-## 🛠️ Development Tips
-
-### Import Organization
-
-```typescript
-// Group imports by category
-import { 
-  // Data models
-  ICluster,
-  IService,
-  IImage,
-  
-  // Requests
-  IRequest_CreateCluster,
-  IRequest_DeployService,
-  
-  // Configuration
-  ICloudlyConfig,
-  IReverseProxyConfig
-} from '@serve.zone/interfaces';
-```
-
-### Type Guards
-
-```typescript
-import { IService, ICluster } from '@serve.zone/interfaces';
-
-function isService(entity: IService | ICluster): entity is IService {
-  return 'imageId' in entity.data;
-}
+```bash
+pnpm install
+pnpm run build
+pnpm test
 ```
 
-## License and Legal Information
-
-This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. 
-
-**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
-
-### Trademarks
-
-This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
-
-### Company Information
-
-Task Venture Capital GmbH  
-Registered at District court Bremen HRB 35230 HB, Germany
-
-For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
+## Ownership
 
-By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
+Only ecosystem-wide public contracts belong here. Cloudly-internal implementation types should stay in Cloudly.

package/{ts_interfaces → ts}/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@serve.zone/interfaces',
-  version: '1.1.2',
-  description: 'interfaces for working with containers'
+  version: '5.4.3',
+  description: 'Shared TypeScript interfaces and TypedRequest contracts for the serve.zone ecosystem.'
 }

package/ts/data/dns.ts

@@ -0,0 +1,100 @@
+export type TDnsRecordType = 'A' | 'AAAA' | 'CNAME' | 'MX' | 'TXT' | 'NS' | 'SOA' | 'SRV' | 'CAA' | 'PTR';
+
+export interface IDnsEntry {
+  id: string;
+  data: {
+    /**
+     * The DNS record type
+     */
+    type: TDnsRecordType;
+    
+    /**
+     * The DNS record name (e.g., www, @, mail)
+     * @ represents the root domain
+     */
+    name: string;
+    
+    /**
+     * The value of the DNS record
+     * - For A/AAAA: IP address
+     * - For CNAME: Target domain
+     * - For MX: Mail server hostname
+     * - For TXT: Text value
+     * - For NS: Nameserver hostname
+     * - For SRV: Target hostname
+     * - For CAA: CAA record value
+     * - For PTR: Domain name
+     */
+    value: string;
+    
+    /**
+     * Time to live in seconds
+     * Default: 3600 (1 hour)
+     */
+    ttl: number;
+    
+    /**
+     * Priority (used for MX and SRV records)
+     * Lower values have higher priority
+     */
+    priority?: number;
+    
+    /**
+     * The DNS zone this entry belongs to
+     * e.g., example.com
+     * @deprecated Use domainId instead
+     */
+    zone: string;
+    
+    /**
+     * The domain ID this DNS entry belongs to
+     * Links to the Domain entity
+     */
+    domainId?: string;
+    
+    /**
+     * Additional fields for SRV records
+     */
+    weight?: number;
+    port?: number;
+    
+    /**
+     * Whether this DNS entry is active
+     */
+    active: boolean;
+    
+    /**
+     * Optional description for documentation
+     */
+    description?: string;
+    
+    /**
+     * Timestamp when the entry was created
+     */
+    createdAt?: number;
+    
+    /**
+     * Timestamp when the entry was last updated
+     */
+    updatedAt?: number;
+    
+    /**
+     * Whether this DNS entry was auto-generated
+     */
+    isAutoGenerated?: boolean;
+    
+    /**
+     * The service ID that created this DNS entry (for auto-generated entries)
+     */
+    sourceServiceId?: string;
+    
+    /**
+     * The source type of this DNS entry
+     * - manual: Created by user through UI/API
+     * - service: Auto-generated from service configuration
+     * - system: Created by system processes
+     * - external: Synced from external DNS providers
+     */
+    sourceType?: 'manual' | 'service' | 'system' | 'external';
+  };
+}

package/ts/data/domain.ts

@@ -0,0 +1,124 @@
+export type TDomainStatus = 'active' | 'pending' | 'expired' | 'suspended' | 'transferred';
+export type TDomainVerificationStatus = 'verified' | 'pending' | 'failed' | 'not_required';
+
+export interface IDomain {
+  id: string;
+  data: {
+    /**
+     * The domain name (e.g., example.com)
+     */
+    name: string;
+    
+    /**
+     * Description or notes about the domain
+     */
+    description?: string;
+    
+    /**
+     * Current status of the domain
+     */
+    status: TDomainStatus;
+    
+    /**
+     * Domain verification status
+     */
+    verificationStatus: TDomainVerificationStatus;
+    
+    /**
+     * Nameservers for the domain
+     */
+    nameservers: string[];
+    
+    /**
+     * Domain registrar information
+     */
+    registrar?: {
+      name: string;
+      url?: string;
+    };
+    
+    /**
+     * Domain registration date (timestamp)
+     */
+    registeredAt?: number;
+    
+    /**
+     * Domain expiration date (timestamp)
+     */
+    expiresAt?: number;
+    
+    /**
+     * Whether auto-renewal is enabled
+     */
+    autoRenew: boolean;
+    
+    /**
+     * DNSSEC enabled
+     */
+    dnssecEnabled?: boolean;
+    
+    /**
+     * Tags for categorization
+     */
+    tags?: string[];
+    
+    /**
+     * Whether this domain is primary for the organization
+     */
+    isPrimary?: boolean;
+    
+    /**
+     * SSL certificate status
+     */
+    sslStatus?: 'active' | 'pending' | 'expired' | 'none';
+
+    /**
+     * Cloudly activation state controls whether we actively manage DNS/certificates
+     * - available: discovered/imported, not actively managed
+     * - activated: actively managed (DNS edits allowed, certs considered)
+     * - ignored: explicitly ignored from management/automation
+     */
+    activationState?: 'available' | 'activated' | 'ignored';
+    
+    /**
+     * Last verification attempt timestamp
+     */
+    lastVerificationAt?: number;
+    
+    /**
+     * Verification method used
+     */
+    verificationMethod?: 'dns' | 'http' | 'email' | 'manual';
+    
+    /**
+     * Verification token (for DNS/HTTP verification)
+     */
+    verificationToken?: string;
+    
+    /**
+     * Cloudflare zone ID if managed by Cloudflare
+     */
+    cloudflareZoneId?: string;
+
+    /**
+     * Sync metadata
+     */
+    syncSource?: 'cloudflare' | 'manual' | null;
+    lastSyncAt?: number;
+    
+    /**
+     * Whether domain is managed externally
+     */
+    isExternal?: boolean;
+    
+    /**
+     * Creation timestamp
+     */
+    createdAt?: number;
+    
+    /**
+     * Last update timestamp
+     */
+    updatedAt?: number;
+  };
+}