@vates/types 1.4.0 → 1.5.0

package/dist/common.d.mts

@@ -517,6 +517,12 @@ export declare const OPAQUE_REF: {
     readonly EMPTY: "OpaqueRef:NULL";
 };
 export type OPAQUE_REF_NULL = (typeof OPAQUE_REF)['EMPTY'];
+export declare const BACKUP_TYPE: {
+    readonly backup: "backup";
+    readonly metadata: "metadataBackup";
+    readonly mirror: "mirrorBackup";
+};
+export type BACKUP_TYPE = (typeof BACKUP_TYPE)[keyof typeof BACKUP_TYPE];
 type XapiStatsResponse<T> = {
     endTimestamp: number;
     interval: number;
@@ -524,43 +530,63 @@ type XapiStatsResponse<T> = {
 };
 export type XapiStatsGranularity = 'seconds' | 'minutes' | 'hours' | 'days';
 export type XapiHostStats = XapiStatsResponse<{
-    cpus: Record<string, number[]>;
-    ioThroughput: {
+    cpus?: Record<string, number[]>;
+    ioThroughput?: {
         r: Record<string, number[]>;
         w: Record<string, number[]>;
     };
-    iops: {
+    iops?: {
         r: Record<string, number[]>;
         w: Record<string, number[]>;
     };
-    iowait: Record<string, number[]>;
-    latency: {
+    iowait?: Record<string, number[]>;
+    latency?: {
         r: Record<string, number[]>;
         w: Record<string, number[]>;
     };
-    load: number[];
-    memory: number[];
-    memoryFree: number[];
-    pifs: {
+    load?: number[];
+    memory?: number[];
+    memoryFree?: number[];
+    pifs?: {
         rx: Record<string, number[]>;
         tx: Record<string, number[]>;
     };
 }>;
 export type XapiVmStats = XapiStatsResponse<{
-    cpus: Record<string, number[]>;
-    iops: {
+    cpus?: Record<string, number[]>;
+    cpuUsage?: number[];
+    runstateFullrun?: number[];
+    runstateFullContention?: number[];
+    runstatePartialRun?: number[];
+    runstatePartialContention?: number[];
+    runstateConcurrencyHazard?: number[];
+    runstateBlocked?: number[];
+    iops?: {
         r: Record<string, number[]>;
         w: Record<string, number[]>;
     };
-    memory: number[];
+    memory?: number[];
     memoryFree?: number[];
-    vifs: {
+    memoryTarget?: number[];
+    vifs?: {
+        rx: Record<string, number[]>;
+        tx: Record<string, number[]>;
+    };
+    vifErrors?: {
         rx: Record<string, number[]>;
         tx: Record<string, number[]>;
     };
-    xvds: {
+    xvds?: {
+        w?: Record<string, number[]>;
+        r?: Record<string, number[]>;
+        total?: Record<string, number[]>;
+    };
+    vbdLatency?: {
         w: Record<string, number[]>;
         r: Record<string, number[]>;
     };
+    vbdIowait?: Record<string, number[]>;
+    vbdInflight?: Record<string, number[]>;
+    vbdAvgquSz?: Record<string, number[]>;
 }>;
 export {};

package/dist/common.mjs

@@ -445,3 +445,4 @@ export const CERTIFICATE_TYPE = {
     HOST_INTERNAL: 'host_internal',
 };
 export const OPAQUE_REF = { EMPTY: 'OpaqueRef:NULL' };
+export const BACKUP_TYPE = { backup: 'backup', metadata: 'metadataBackup', mirror: 'mirrorBackup' };

package/dist/lib/xen-orchestra-xapi.d.mts

@@ -0,0 +1,50 @@
+import { WrappedXenApiRecord, XenApiNetworkWrapped, XenApiRecord } from '../xen-api.mjs';
+import type { XoHost, XoNetwork, XoPif } from '../xo.mjs';
+type XcpPatches = {
+    changelog?: {
+        author: string;
+        date: number;
+        description: string;
+    };
+    description: string;
+    license: string;
+    name: string;
+    release: string;
+    size: number;
+    url: string;
+    version: string;
+};
+type XsPatches = {
+    conflicts?: string[];
+    date: string;
+    description: string;
+    documentationUrl?: string;
+    guidances: string;
+    name: string;
+    id?: string;
+    paid?: boolean;
+    requirements?: string[];
+    upgrade?: boolean;
+    url?: string;
+    uuid?: string;
+};
+export interface Xapi {
+    call: <ReturnType>(...args: unknown[]) => Promise<ReturnType>;
+    callAsync: <ReturnType>(...args: unknown[]) => Promise<ReturnType>;
+    getField<T extends XenApiRecord, K extends keyof T>(type: Extract<WrappedXenApiRecord, T>['$type'], ref: T['$ref'], field: K): Promise<T[K]>;
+    createNetwork(params: {
+        name: string;
+        description?: string;
+        mtu?: number;
+    } | {
+        name: string;
+        description?: string;
+        pifId: XoPif['id'];
+        mtu?: number;
+        vlan: number;
+    }): Promise<XenApiNetworkWrapped>;
+    deleteNetwork(id: XoNetwork['id']): Promise<void>;
+    listMissingPatches(host: XoHost['id']): Promise<XcpPatches[] | XsPatches[]>;
+    pool_emergencyShutdown(): Promise<void>;
+}
+export {};

package/dist/lib/xen-orchestra-xapi.mjs

@@ -0,0 +1 @@
+export {};

package/dist/xen-api.d.mts

@@ -1,4 +1,5 @@
 import type { AFTER_APPLY_GUIDANCE, ALLOCATION_ALGORITHM, BOND_MODE, Branded, CERTIFICATE_TYPE, CLS, CLUSTER_HOST_OPERATION, CLUSTER_OPERATION, CONSOLE_PROTOCOL, DOMAIN_TYPE, EVENT_OPERATION, HOST_ALLOWED_OPERATIONS, HOST_DISPLAY, HOST_NUMA_AFFINITY_POLICY, IP_CONFIGURATION_MODE, IPV6_CONFIGURATION_MODE, LATEST_SYNCED_UPDATES_APPLIED_STATE, NETWORK_DEFAULT_LOCKING_MODE, NETWORK_OPERATIONS, NETWORK_PURPOSE, ON_BOOT, ON_CRASH_BEHAVIOUR, ON_NORMAL_EXIT, ON_SOFTREBOOT_BEHAVIOR, OPAQUE_REF_NULL, PERSISTENCE_BACKEND, PGPU_DOM0_ACCESS, PIF_IGMP_STATUS, POOL_ALLOWED_OPERATIONS, PRIMARY_ADDRESS_TYPE, PVS_PROXY_STATUS, SDN_CONTROLLER_PROTOCOL, SR_HEALTH, SRIOV_CONFIGURATION_MODE, STORAGE_OPERATIONS, TASK_ALLOWED_OPERATIONS, TASK_STATUS_TYPE, TELEMETRY_FREQUENCY, TRISTATE_TYPE, TUNNEL_PROTOCOL, UPDATE_AFTER_APPLY_GUIDANCE, UPDATE_GUIDANCES, UPDATE_SYNC_FREQUENCY, VBD_MODE, VBD_OPERATIONS, VBD_TYPE, VDI_OPERATIONS, VDI_TYPE, VGPU_TYPE_IMPLEMENTATION, VIF_IPV4_CONFIGURATION_MODE, VIF_IPV6_CONFIGURATION_MODE, VIF_LOCKING_MODE, VIF_OPERATIONS, VM_APPLIANCE_OPERATION, VM_OPERATIONS, VM_POWER_STATE, VMPP_ARCHIVE_FREQUENCY, VMPP_ARCHIVE_TARGET_TYPE, VMPP_BACKUP_FREQUENCY, VMPP_BACKUP_TYPE, VMSS_FREQUENCY, VMSS_TYPE, VTPM_OPERATIONS, VUSB_OPERATIONS } from './common.mjs';
+import type { Xapi } from './lib/xen-orchestra-xapi.mjs';
 /**
  * Add properties injected by `xen-api`.
  * $ref property is also injected by XOLite, so she is not present here.
@@ -15,11 +16,7 @@ type WrapperXenApi<T, Type extends string, Fn = {
         name_label?: string;
         unplugVusbs?: boolean;
     }): Promise<XenApiVm['$ref']>;
-    $xapi: {
-        call: <ReturnType>(...args: unknown[]) => Promise<ReturnType>;
-        callAsync: <ReturnType>(...args: unknown[]) => Promise<ReturnType>;
-        getField<T extends XenApiRecord, K extends keyof T>(type: Type, ref: T['$ref'], field: K): Promise<T[K]>;
-    };
+    $xapi: Xapi;
 };
 export interface XenApiSession {
     $ref: Branded<'session'>;
@@ -187,6 +184,8 @@ type XenApiVmCallMethods = {
     (method: 'hard_shutdown'): Promise<void>;
     (method: 'clean_reboot'): Promise<void>;
     (method: 'hard_reboot'): Promise<void>;
+    (method: 'record_data_source', dataSource: string): Promise<void>;
+    (method: 'forget_data_source_archives', dataSource: string): Promise<void>;
 };
 export interface XenApiVm {
     $ref: Branded<'VM'>;
@@ -542,6 +541,8 @@ export interface XenApiNetwork {
     uuid: string;
     VIFs: XenApiVif['$ref'][];
 }
+export interface XenApiNetworkWrapped extends WrapperXenApi<XenApiNetwork, 'network'> {
+}
 export interface XenApiVif {
     $ref: Branded<'VIF'>;
     allowed_operations: VIF_OPERATIONS[];
@@ -916,6 +917,7 @@ export interface XenApiPci {
     uuid: string;
     vendor_name: string;
 }
+export type XenApiPciWrapped = WrapperXenApi<XenApiPci, 'PCI'>;
 export interface XenApiPgpu {
     $ref: Branded<'PGPU'>;
     compatibility_metadata?: Record<string, string>;
@@ -931,6 +933,7 @@ export interface XenApiPgpu {
     supported_VGPU_types: XenApiVgpuType['$ref'][];
     uuid: string;
 }
+export type XenApiPgpuWrapped = WrapperXenApi<XenApiPgpu, 'PGPU'>;
 export interface XenApiGpuGroup {
     $ref: Branded<'GPU_group'>;
     allocation_algorithm: ALLOCATION_ALGORITHM;
@@ -944,6 +947,7 @@ export interface XenApiGpuGroup {
     uuid: string;
     VGPUs: XenApiVgpu['$ref'][];
 }
+export type XenApiGpuGroupWrapped = WrapperXenApi<XenApiGpuGroup, 'gpuGroup'>;
 export interface XenApiVgpu {
     $ref: Branded<'VGPU'>;
     compatibility_metadata?: Record<string, string>;
@@ -979,6 +983,7 @@ export interface XenApiVgpuType {
     vendor_name: string;
     VGPUs: XenApiVgpu['$ref'][];
 }
+export type XenApiVgpuTypeWrapped = WrapperXenApi<XenApiVgpuType, 'vgpuType'>;
 export interface XenApiPvsSite {
     $ref: Branded<'PVS_site'>;
     cache_storage?: XenApiPvsCacheStorage['$ref'][];
@@ -1142,5 +1147,5 @@ export interface XenApiObserver {
     uuid?: string;
 }
 export type XenApiRecord = XenApiSession | XenApiAuth | XenApiSubject | XenApiRole | XenApiTask | XenApiEvent | XenApiPool | XenApiPoolPatch | XenApiPoolUpdate | XenApiVm | XenApiVmMetrics | XenApiVmGuestMetrics | XenApiVmpp | XenApiVmss | XenApiVmAppliance | XenApiDrTask | XenApiHost | XenApiHostCrashdump | XenApiHostPatch | XenApiHostMetrics | XenApiHostCpu | XenApiNetwork | XenApiVif | XenApiVifMetrics | XenApiPif | XenApiPifMetrics | XenApiBond | XenApiVlan | XenApiSm | XenApiSr | XenApiSrStat | XenApiProbeResult | XenApiLvhd | XenApiVdi | XenApiVbd | XenApiVbdMetrics | XenApiPbd | XenApiCrashdump | XenApiVtpm | XenApiConsole | XenApiUser | XenApiDataSource | XenApiBlob | XenApiMessage | XenApiSecret | XenApiTunnel | XenApiNetworkSriov | XenApiPci | XenApiPgpu | XenApiGpuGroup | XenApiVgpu | XenApiVgpuType | XenApiPvsSite | XenApiPvsServer | XenApiPvsProxy | XenApiPvsCacheStorage | XenApiFeature | XenApiSdnController | XenApiVdiNbdServerInfo | XenApiPusb | XenApiUsbGroup | XenApiVusb | XenApiCluster | XenApiClusterHost | XenApiCertificate | XenApiRepository | XenApiObserver;
-export type WrappedXenApiRecord = XenApiHostWrapped | XenApiPifWrapped | XenApiPoolWrapped | XenApiSrWrapped | XenApiVbdWrapped | XenApiVdiWrapped | XenApiVgpuWrapped | XenApiVifWrapped | XenApiVmWrapped | XenApiVtpmWrapped;
+export type WrappedXenApiRecord = XenApiHostWrapped | XenApiNetworkWrapped | XenApiPifWrapped | XenApiPoolWrapped | XenApiSrWrapped | XenApiVbdWrapped | XenApiVdiWrapped | XenApiVgpuWrapped | XenApiVifWrapped | XenApiVmWrapped | XenApiVtpmWrapped | XenApiPciWrapped | XenApiGpuGroupWrapped | XenApiPgpuWrapped | XenApiVgpuTypeWrapped;
 export {};

package/dist/xo.d.mts

@@ -1,4 +1,4 @@
-import type { Branded, DOMAIN_TYPE, HOST_ALLOWED_OPERATIONS, HOST_POWER_STATE, IP_CONFIGURATION_MODE, IPV6_CONFIGURATION_MODE, NETWORK_OPERATIONS, POOL_ALLOWED_OPERATIONS, PRIMARY_ADDRESS_TYPE, STORAGE_OPERATIONS, VDI_OPERATIONS, VDI_TYPE, VIF_LOCKING_MODE, VM_OPERATIONS, VM_POWER_STATE } from './common.mjs';
+import type { BACKUP_TYPE, Branded, DOMAIN_TYPE, HOST_ALLOWED_OPERATIONS, HOST_POWER_STATE, IP_CONFIGURATION_MODE, IPV6_CONFIGURATION_MODE, NETWORK_OPERATIONS, PGPU_DOM0_ACCESS, POOL_ALLOWED_OPERATIONS, PRIMARY_ADDRESS_TYPE, STORAGE_OPERATIONS, VDI_OPERATIONS, VDI_TYPE, VIF_LOCKING_MODE, VM_OPERATIONS, VM_POWER_STATE } from './common.mjs';
 type BaseXapiXo = {
     $pool: XoPool['id'];
     /**
@@ -48,7 +48,7 @@ type BaseXoVm = BaseXapiXo & {
     isNestedVirtEnabled: boolean;
     hasVendorDevice: boolean;
     high_availability: string;
-    installTime?: number;
+    installTime?: number | null;
     isFirmwareSupported: boolean;
     memory: {
         dynamic: number[];
@@ -74,20 +74,13 @@ type BaseXoVm = BaseXapiXo & {
     secureBoot: boolean;
     snapshots: XoVmSnapshot['id'][];
     startDelay: number;
-    startTime?: number;
+    startTime?: number | null;
     suspendSr?: XoSr['id'];
     tags: string[];
     vga?: string;
     videoram?: number;
     viridian: boolean;
     virtualizationMode: DOMAIN_TYPE;
-    vulnerabilities: {
-        xsa468: boolean | {
-            reason: string;
-            driver?: string;
-            version?: string;
-        };
-    };
     xenStoreData: Record<string, string>;
     /**
      * @deprecated use pvDriversVersion instead
@@ -109,6 +102,24 @@ export type XoAlarm = Omit<XoMessage, '$object' | 'body'> & {
         href?: string;
     };
 };
+export type XoBackupRepository = {
+    benchmarks?: {
+        readRate: number;
+        timestamp: number;
+        writeRate: number;
+    }[];
+    enabled: boolean;
+    error?: Record<string, unknown>;
+    id: Branded<'backup-repository'>;
+    name: string;
+    options?: string;
+    proxy?: XoProxy['id'];
+    url: string;
+};
+export type XoGpuGroup = BaseXapiXo & {
+    id: Branded<'gpu-group'>;
+    type: 'gpuGroup';
+};
 export type XoGroup = {
     id: Branded<'group'>;
     name: string;
@@ -230,12 +241,30 @@ export type XoPbd = BaseXapiXo & {
     type: 'PBD';
 };
 export type XoPci = BaseXapiXo & {
+    $host?: XoHost['id'];
+    class_name: string;
+    device_name: string;
     id: Branded<'PCI'>;
+    pci_id: string;
     type: 'PCI';
 };
 export type XoPgpu = BaseXapiXo & {
+    $host: XoHost['id'];
+    $vgpus: XoVgpu['id'][];
+    dom0Access: PGPU_DOM0_ACCESS;
+    enabledVgpuTypes: XoVgpuType['id'][];
+    gpuGroup?: XoGpuGroup['id'];
+    host: XoHost['id'];
     id: Branded<'PGPU'>;
+    isSystemDisplayDevice: boolean;
+    pci?: XoPci['id'];
+    /**
+     * @deprecated
+     */
+    supportedVgpuMaxCapcities?: never;
+    supportedVgpuTypes: XoVgpuType['id'][];
     type: 'PGPU';
+    vgpus: XoVgpu['id'][];
 };
 export type XoPif = BaseXapiXo & {
     $host: XoHost['id'];
@@ -291,14 +320,80 @@ export type XoPool = BaseXapiXo & {
     xosanPackInstallationTime: number | null;
     zstdSupported: boolean;
 };
-export type XoJob = {
+export type XoProxy = {
+    id: Branded<'proxy'>;
+};
+type BaseXoJob = {
     id: Branded<'job'>;
 };
+export type XoBackupJob = BaseXoJob & {
+    compression?: 'native' | 'zstd' | '';
+    proxy?: XoProxy['id'];
+    mode: 'full' | 'delta';
+    name?: string;
+    remotes?: {
+        id: XoBackupRepository['id'] | {
+            __or: XoBackupRepository['id'][];
+        };
+    };
+    vms?: {
+        id: XoVm['id'] | {
+            __or: XoVm['id'][];
+        } | Record<string, unknown>;
+    };
+    srs: {
+        id: XoSr['id'] | {
+            __or: XoSr['id'][];
+        };
+    };
+    type: BACKUP_TYPE;
+    settings: {
+        '': {
+            cbtDestroySnapshotData?: boolean;
+            concurrency?: number;
+            longTermRetention?: {
+                daily?: {
+                    retention: number;
+                    settings: Record<string, unknown>;
+                };
+                weekly?: {
+                    retention: number;
+                    settings: Record<string, unknown>;
+                };
+                monthly?: {
+                    retention: number;
+                    settings: Record<string, unknown>;
+                };
+                yearly?: {
+                    retention: number;
+                    settings: Record<string, unknown>;
+                };
+            };
+            maxExportRate?: number;
+            nbdConcurrency?: number;
+            nRetriesVmBackupFailures?: number;
+            preferNbd?: boolean;
+            timezone?: string;
+            [key: string]: unknown;
+        };
+        [key: XoSchedule['id']]: {
+            exportRetention?: number;
+            healthCheckSr?: XoSr['id'];
+            healthCheckVmsWithTags?: string[];
+            fullInterval?: number;
+            copyRetention?: number;
+            snapshotRetention?: number;
+            cbtDestroySnapshotData?: boolean;
+            [key: string]: unknown;
+        };
+    };
+};
+export type XoJob = BaseXoJob & {};
 export type XoSchedule = {
     cron: string;
-    enable: boolean;
+    enabled: boolean;
     id: Branded<'schedule'>;
-    jobId: XoJob['id'];
+    jobId: (XoJob | XoBackupJob)['id'];
     name?: string;
     timezone?: string;
 };
@@ -310,6 +405,7 @@ export type XoServer = {
     httpProxy?: string;
     id: Branded<'server'>;
     label?: string;
+    master?: XoHost['id'];
     poolId?: XoPool['id'];
     poolNameDescription?: string;
     poolNameLabel?: string;
@@ -320,7 +416,7 @@ export type XoServer = {
 export type XoSr = BaseXapiXo & {
     $PBDs: XoPbd['id'][];
     $container: XoPool['id'] | XoHost['id'];
-    VDIs: XoVdi['id'][];
+    VDIs: AnyXoVdi['id'][];
     allocationStrategy: 'thin' | 'thick' | 'unknown';
     content_type: string;
     current_operations: Record<string, STORAGE_OPERATIONS>;
@@ -329,9 +425,9 @@ export type XoSr = BaseXapiXo & {
     name_description: string;
     name_label: string;
     other_config: Record<string, string>;
-    physical_usage: number | null;
+    physical_usage: number;
     shared: boolean;
-    size: number | null;
+    size: number;
     sm_config: Record<string, string>;
     SR_type: string;
     tags: string[];
@@ -357,8 +453,8 @@ export type XoVbd = BaseXapiXo & {
     position: string;
     read_only: boolean;
     type: 'VBD';
-    VDI: XoVdi['id'];
-    VM: XoVm['id'];
+    VDI: AnyXoVdi['id'];
+    VM: AnyXoVm['id'];
 };
 type BaseXoVdi = BaseXapiXo & {
     $SR: XoSr['id'];
@@ -392,7 +488,11 @@ export type XoVdiUnmanaged = BaseXoVdi & {
 };
 export type XoVgpu = BaseXapiXo & {
     id: Branded<'VGPU'>;
-    type: 'VGPU';
+    type: 'vgpu';
+};
+export type XoVgpuType = BaseXapiXo & {
+    id: Branded<'vgpu-type'>;
+    type: 'vgpuType';
 };
 export type XoVif = BaseXapiXo & {
     $VM: XoVm['id'];
@@ -416,6 +516,13 @@ export type XoVif = BaseXapiXo & {
 export type XoVm = BaseXoVm & {
     id: Branded<'VM'>;
     type: 'VM';
+    vulnerabilities: {
+        xsa468: boolean | {
+            reason: string;
+            driver?: string;
+            version?: string;
+        };
+    };
 };
 export type XoVmController = BaseXoVm & {
     id: Branded<'VM-controller'>;
@@ -448,7 +555,10 @@ export type XoVtpm = BaseXapiXo & {
     id: Branded<'VTPM'>;
     type: 'VTPM';
 };
-export type XapiXoRecord = XoAlarm | XoHost | XoMessage | XoNetwork | XoPif | XoPool | XoSr | XoVbd | XoVdi | XoVdiSnapshot | XoVdiUnmanaged | XoVgpu | XoVif | XoVm | XoVmController | XoVmSnapshot | XoVmTemplate | XoVtpm;
-export type NonXapiXoRecord = XoGroup | XoJob | XoSchedule | XoServer | XoUser;
+export type XapiXoRecord = XoAlarm | XoGpuGroup | XoHost | XoMessage | XoNetwork | XoPci | XoPgpu | XoPif | XoPool | XoSr | XoVbd | XoVdi | XoVdiSnapshot | XoVdiUnmanaged | XoVgpu | XoVgpuType | XoVif | XoVm | XoVmController | XoVmSnapshot | XoVmTemplate | XoVtpm;
+export type NonXapiXoRecord = XoGroup | XoProxy | XoJob | XoBackupRepository | XoSchedule | XoServer | XoUser;
 export type XoRecord = XapiXoRecord | NonXapiXoRecord;
+export type AnyXoVm = XoVm | XoVmSnapshot | XoVmTemplate | XoVmController;
+export type AnyXoVdi = XoVdi | XoVdiSnapshot | XoVdiUnmanaged;
+export type AnyXoJob = XoJob | XoBackupJob;
 export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vates/types",
   "private": false,
-  "version": "1.4.0",
+  "version": "1.5.0",
   "main": "./dist/index.mjs",
   "exports": {
     ".": {
@@ -17,6 +17,10 @@
     "./lib/vates/*": {
       "default": "./dist/lib/vates-*.mjs",
       "type": "./dist/lib/vates-*.d.mts"
+    },
+    "./lib/xen-orchestra/*": {
+      "default": "./dist/lib/xen-orchestra-*.mjs",
+      "type": "./dist/lib/xen-orchestra-*.d.mts"
     }
   },
   "type": "module",