@vates/types 1.10.0 → 1.12.0

package/dist/common.d.mts

@@ -524,6 +524,12 @@ export declare const BACKUP_TYPE: {
     readonly mirror: "mirrorBackup";
 };
 export type BACKUP_TYPE = (typeof BACKUP_TYPE)[keyof typeof BACKUP_TYPE];
+export declare const SUPPORTED_VDI_FORMAT: {
+    readonly raw: "raw";
+    readonly vhd: "vhd";
+    readonly qcow2: "qcow2";
+};
+export type SUPPORTED_VDI_FORMAT = (typeof SUPPORTED_VDI_FORMAT)[keyof typeof SUPPORTED_VDI_FORMAT];
 type XapiStatsResponse<T> = {
     endTimestamp: number;
     interval: number;

package/dist/common.mjs

@@ -446,3 +446,8 @@ export const CERTIFICATE_TYPE = {
 };
 export const OPAQUE_REF = { EMPTY: 'OpaqueRef:NULL' };
 export const BACKUP_TYPE = { backup: 'backup', metadata: 'metadataBackup', mirror: 'mirrorBackup' };
+export const SUPPORTED_VDI_FORMAT = {
+    raw: 'raw',
+    vhd: 'vhd',
+    qcow2: 'qcow2',
+};

package/dist/index.d.mts

@@ -2,3 +2,4 @@ export * from './common.mjs';
 export * from './xen-api.mjs';
 export * from './xo.mjs';
 export * from './lib/xen-orchestra-xapi.mjs';
+export * from './lib/complex-matcher.mjs';

package/dist/index.mjs

@@ -2,3 +2,4 @@ export * from './common.mjs';
 export * from './xen-api.mjs';
 export * from './xo.mjs';
 export * from './lib/xen-orchestra-xapi.mjs';
+export * from './lib/complex-matcher.mjs';

package/dist/lib/complex-matcher.d.mts

@@ -0,0 +1,7 @@
+export type Or<T> = Id<{
+    __or: T[];
+}>;
+export type Id<T> = {
+    id: T;
+};
+export type IdOr<T> = Id<T> | Or<T>;

package/dist/lib/complex-matcher.mjs

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

package/dist/lib/vates-task.d.mts

@@ -1,5 +1,18 @@
 import { Branded } from '../common.mjs';
-export type Task = {
-    id: Branded<'task'>;
-    run: <T>(fn: () => T) => Promise<T>;
-};
+export interface VatesTask {
+    _abortController: AbortController;
+    _onProgress(data?: unknown): void;
+    id: Branded<'vates-task'>;
+    status: 'failure' | 'pending' | 'success';
+    abort(reason?: unknown): void;
+    failure(error?: unknown): void;
+    info(message: string, data: unknown): void;
+    run<T>(fn: () => T | (() => Promise<T>)): Promise<T>;
+    runInside<T>(fn: () => T | (() => Promise<T>)): Promise<T>;
+    set(name: string, value: unknown): void;
+    start(): void;
+    success(result?: unknown): void;
+    warning(message: string, data: unknown): void;
+    wrap<T>(fn: () => T | (() => Promise<T>)): Promise<T>;
+    wrapInside<T>(fn: () => T | (() => Promise<T>)): Promise<T>;
+}

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

@@ -1,6 +1,7 @@
 import { WrappedXenApiRecord, XenApiHost, XenApiNetworkWrapped, XenApiRecord, XenApiSr, XenApiTask, XenApiVdi, XenApiVm, XenApiVmWrapped } from '../xen-api.mjs';
-import type { Readable } from 'node:stream';
+import type { PassThrough, Readable } from 'node:stream';
 import type { XoGpuGroup, XoVgpuType, XoHost, XoNetwork, XoPif, XoSr, XoUser, XoVdi, XoVm, XoVmTemplate } from '../xo.mjs';
+import type { SUPPORTED_VDI_FORMAT } from '../common.mjs';
 export type XcpPatches = {
     changelog?: {
         author: string;
@@ -45,10 +46,24 @@ export interface Xapi {
         vlan: number;
     }): Promise<XenApiNetworkWrapped>;
     deleteNetwork(id: XoNetwork['id']): Promise<void>;
+    exportVmOva(vmRef: XenApiVm['$ref']): Promise<PassThrough>;
     listMissingPatches(host: XoHost['id']): Promise<XcpPatches[] | XsPatches[]>;
     pool_emergencyShutdown(): Promise<void>;
     resumeVm(id: XoVm['id']): Promise<void>;
     unpauseVm(id: XoVm['id']): Promise<void>;
+    SR_importVdi(ref: XenApiSr['$ref'], stream: Readable, opts?: {
+        format?: SUPPORTED_VDI_FORMAT;
+        name_description?: XoVdi['name_description'];
+        name_label?: XoVdi['name_label'];
+        other_config?: XoVdi['other_config'];
+        read_only?: boolean;
+        sharable?: boolean;
+        SR?: XenApiSr['$ref'];
+        tags?: XoVdi['tags'];
+        type?: XoVdi['type'];
+        virtual_size?: XoVdi['size'];
+        xenstore_data?: Record<string, string>;
+    }): Promise<XenApiVdi['$ref']>;
     startVm(id: XoVm['id'], opts?: {
         bypassMacAddressesCheck?: boolean;
         force?: boolean;
@@ -61,6 +76,11 @@ export interface Xapi {
          */
         startOnly?: boolean;
     }): Promise<void>;
+    VM_export(vmRef: XenApiVm['$ref'], opts?: {
+        cancelToken?: unknown;
+        compress?: boolean;
+        useSnapshot?: boolean;
+    }): ReturnType<Xapi['getResource']>;
     VM_import(stream: Readable, srRef?: XenApiSr['$ref'], onVmCreation?: null | ((vm: XenApiVm) => unknown)): Promise<XenApiVm['$ref']>;
     createVm(templateUuid: XoVmTemplate['uuid'], metadataVm: {
         affinityHost?: XoHost['id'];
@@ -108,9 +128,17 @@ export interface Xapi {
     }, checkLimits?: boolean, creatorId?: XoUser['id'], opts?: {
         destroyAllVifs: boolean;
     }): Promise<XenApiVmWrapped>;
+    VDI_destroy(vdiRef: XenApiVdi['$ref']): Promise<void>;
     VDI_destroyCloudInitConfig(vdiRef: XenApiVdi['$ref'], opts?: {
         timeLimit?: number;
     }): Promise<void>;
+    VDI_exportContent(vdiRef: XenApiVdi['$ref'], opts: {
+        baseRef?: string;
+        cancelToken?: unknown;
+        format: SUPPORTED_VDI_FORMAT;
+    }): Promise<Readable & {
+        length?: number;
+    }>;
     VM_createCloudInitConfig(vmRef: XenApiVm['$ref'], cloudConfig: string, opts?: {
         networkConfig?: string;
     }): Promise<XoVdi['uuid']>;

package/dist/xo.d.mts

@@ -1,4 +1,5 @@
-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';
+import 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';
+import type * as CMType from './lib/complex-matcher.mjs';
 type BaseXapiXo = {
     $pool: XoPool['id'];
     /**
@@ -102,6 +103,16 @@ export type XoAlarm = Omit<XoMessage, '$object' | 'body'> & {
         href?: string;
     };
 };
+type BaseXoLog = {
+    id: Branded<'xo-log'>;
+    [key: string]: unknown;
+};
+export type XoBackupLog = BaseXoLog & {
+    message: 'backup' | 'metadata';
+};
+export type XoRestoreLog = BaseXoLog & {
+    message: 'restore';
+};
 export type XoBackupRepository = {
     benchmarks?: {
         readRate: number;
@@ -322,70 +333,124 @@ export type XoPool = BaseXapiXo & {
 };
 export type XoProxy = {
     id: Branded<'proxy'>;
-};
+    url: string;
+    version?: string;
+    name: string;
+} & ({
+    address?: undefined;
+    vmUuid: XoVm['id'];
+} | {
+    address: string;
+    vmUuid?: undefined;
+} | {
+    address: string;
+    vmUuid: XoVm['id'];
+});
 type BaseXoJob = {
     id: Branded<'job'>;
+    name?: string;
 };
-export type XoBackupJob = BaseXoJob & {
+type XoBackupJobGeneralSettings = {
+    backupReportTpl?: 'compactMjml' | 'mjml';
+    reportWhen?: 'always' | 'error' | 'failure' | 'never';
+    hideSuccessfulItems?: boolean;
+    [key: string]: unknown;
+};
+export type XoVmBackupJobGeneralSettings = XoBackupJobGeneralSettings & {
+    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;
+    mergeBackupsSynchronously?: boolean;
+    offlineBackup?: boolean;
+    timeout?: number;
+    [key: string]: unknown;
+};
+export type XoVmBackupJobScheduleSettings = {
+    exportRetention?: number;
+    healthCheckVmsWithTags?: XoVm['tags'];
+    fullInterval?: number;
+    copyRetention?: number;
+    snapshotRetention?: number;
+    cbtDestroySnapshotData?: boolean;
+    healthCheckSr?: XoSr['id'];
+    [key: string]: unknown;
+};
+export type XoVmBackupJob = 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>;
+    remotes?: CMType.IdOr<XoBackupRepository['id']>;
+    vms: CMType.IdOr<XoVm['id']> | Record<string, unknown>;
+    srs?: CMType.IdOr<XoSr['id']>;
+    type: 'backup';
+    settings: {
+        '': XoVmBackupJobGeneralSettings;
+        [key: XoSchedule['id']]: XoVmBackupJobScheduleSettings | undefined;
     };
-    srs: {
-        id: XoSr['id'] | {
-            __or: XoSr['id'][];
-        };
+};
+export type XoMetadataBackupJobGeneralSettings = XoBackupJobGeneralSettings;
+export type XoMetadataBackupJobScheduleSettings = {
+    retentionPoolMetadata?: number;
+    retentionXoMetadata?: number;
+    [key: string]: unknown;
+};
+export type XoMetadataBackupJob = BaseXoJob & {
+    type: 'metadataBackup';
+    pools?: CMType.IdOr<XoPool['id']>;
+    remotes: CMType.IdOr<XoBackupRepository['id']>;
+    settings: {
+        ''?: XoMetadataBackupJobGeneralSettings;
+        [scheduleId: XoSchedule['id']]: XoMetadataBackupJobScheduleSettings | undefined;
     };
-    type: BACKUP_TYPE;
+    xoMetadata?: boolean;
+    userId: XoUser['id'];
+    proxy?: XoProxy['id'];
+};
+export type XoMirrorBackupGeneralSettings = XoBackupJobGeneralSettings & {
+    concurrency?: number;
+    nRetriesVmBackupFailures?: number;
+    timeout?: number;
+    maxExportRate?: number;
+    backupReportTpl?: 'compactMjml';
+    reportWhen: 'failure';
+    [key: string]: unknown;
+};
+export type XoMirrorBackupScheduleSettings = {
+    exportRetention?: number;
+    healthCheckVmsWithTags?: XoVm['tags'];
+    healthCheckSr?: XoSr['id'];
+    [key: string]: unknown;
+};
+export type XoMirrorBackupJob = BaseXoJob & {
+    type: 'mirrorBackup';
+    mode: 'full' | 'delta';
+    sourceRemote: XoBackupRepository['id'];
+    remotes: CMType.IdOr<XoBackupRepository['id']>;
     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;
-        };
+        '': XoMirrorBackupGeneralSettings;
+        [scheduleId: XoSchedule['id']]: XoMirrorBackupScheduleSettings | undefined;
     };
 };
 export type XoJob = BaseXoJob & {};
@@ -393,7 +458,7 @@ export type XoSchedule = {
     cron: string;
     enabled: boolean;
     id: Branded<'schedule'>;
-    jobId: (XoJob | XoBackupJob)['id'];
+    jobId: AnyXoJob['id'];
     name?: string;
     timezone?: string;
 };
@@ -447,6 +512,33 @@ export type XoSm = BaseXapiXo & {
     supported_image_formats: string[];
     type: 'SM';
 };
+export type XoTask = {
+    abortionRequestedAt?: number;
+    end?: number;
+    id: Branded<'task'>;
+    infos?: {
+        data: unknown;
+        message: string;
+    }[];
+    properties: {
+        method?: string;
+        name?: string;
+        objectId?: string;
+        params?: Record<string, unknown>;
+        type?: string;
+        userId?: string;
+        [key: string]: unknown | undefined;
+    };
+    result: Record<string, unknown>;
+    start: number;
+    status: 'failure' | 'interrupted' | 'pending' | 'success';
+    tasks?: XoTask[];
+    updatedAt?: number;
+    warnings?: {
+        data: unknown;
+        message: string;
+    }[];
+};
 export type XoUser = {
     authProviders?: Record<string, string>;
     email: string;
@@ -457,6 +549,20 @@ export type XoUser = {
     pw_hash?: string;
     preferences: Record<string, string>;
 };
+export type XoAuthenticationToken = {
+    client?: {
+        id: string;
+        [key: string]: unknown;
+    };
+    created_at?: number;
+    description?: string;
+    user_id: XoUser['id'];
+    expiration: number;
+    last_uses?: Record<string, {
+        timestamp: number;
+    }>;
+    id: Branded<'authentication-token'>;
+};
 export type XoVbd = BaseXapiXo & {
     attached: boolean;
     bootable: boolean;
@@ -574,9 +680,11 @@ export type XoVtpm = BaseXapiXo & {
     type: 'VTPM';
 };
 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 | XoSm;
-export type NonXapiXoRecord = XoGroup | XoProxy | XoJob | XoBackupRepository | XoSchedule | XoServer | XoUser;
+export type NonXapiXoRecord = AnyXoJob | AnyXoLog | XoGroup | XoProxy | XoBackupRepository | XoSchedule | XoServer | XoTask | 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 type AnyXoJob = XoJob | AnyXoBackupJob;
+export type AnyXoBackupJob = XoVmBackupJob | XoMetadataBackupJob | XoMirrorBackupJob;
+export type AnyXoLog = XoBackupLog | XoRestoreLog;
 export {};

package/package.json

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