@xen-orchestra/rest-api 0.14.0 → 0.16.0

package/dist/pools/pool.controller.mjs

@@ -17,7 +17,7 @@ import { asynchronousActionResp, createdResp, featureUnauthorized, internalServe
 import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
 import { AlarmService } from '../alarms/alarm.service.mjs';
 import { genericAlarmsExample } from '../open-api/oa-examples/alarm.oa-example.mjs';
-import { createVm, importVm, partialPools, pool, poolDashboard, poolIds, poolStats, } from '../open-api/oa-examples/pool.oa-example.mjs';
+import { createVm, importVm, partialPools, pool, poolDashboard, poolIds, poolMissingPatches, poolStats, } from '../open-api/oa-examples/pool.oa-example.mjs';
 import { taskLocation } from '../open-api/oa-examples/task.oa-example.mjs';
 import { createNetwork } from '../open-api/oa-examples/schedule.oa-example.mjs';
 import { BASE_URL } from '../index.mjs';
@@ -221,6 +221,14 @@ let PoolController = class PoolController extends XapiXoController {
         });
         return this.sendObjects(Object.values(alarms), req, 'alarms');
     }
+    /**
+     * @example id "355ee47d-ff4c-4924-3db2-fd86ae629676"
+     */
+    async getPoolMissingPatches(id) {
+        const pool = this.getObject(id);
+        const { missingPatches } = await this.#poolService.getMissingPatches(pool.id);
+        return missingPatches;
+    }
 };
 __decorate([
     Example(poolIds),
@@ -335,6 +343,13 @@ __decorate([
     __param(4, Query()),
     __param(5, Query())
 ], PoolController.prototype, "getPoolAlarms", null);
+__decorate([
+    Example(poolMissingPatches),
+    Get('{id}/missing_patches'),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(featureUnauthorized.status, featureUnauthorized.description),
+    __param(0, Path())
+], PoolController.prototype, "getPoolMissingPatches", null);
 PoolController = __decorate([
     Route('pools'),
     Security('*'),

package/dist/pools/pool.service.mjs

@@ -1,4 +1,5 @@
 import { createLogger } from '@xen-orchestra/log';
+import { featureUnauthorized } from 'xo-common/api-errors.js';
 import { HOST_POWER_STATE, VM_POWER_STATE, } from '@vates/types';
 import { HostService } from '../hosts/host.service.mjs';
 import { VmService } from '../vms/vm.service.mjs';
@@ -45,13 +46,13 @@ export class PoolService {
         const alarms = this.#alarmService.getAlarms({ filter: alarm => alarm.$pool === poolId });
         return Object.keys(alarms);
     }
-    async #getMissingPatches(poolId) {
-        const missingPatchesInfo = await this.#hostService.getMissingPatchesInfo({ filter: host => host.$pool === poolId });
-        if (!missingPatchesInfo.hasAuthorization) {
-            return {
-                hasAuthorization: false,
-            };
-        }
+    /**
+     * Throw if no authorization
+     */
+    async getMissingPatches(poolId) {
+        const missingPatchesInfo = await this.#hostService.getMissingPatchesInfo({
+            filter: host => host.$pool === poolId,
+        });
         const { hasAuthorization, missingPatches } = missingPatchesInfo;
         return {
             hasAuthorization,
@@ -182,7 +183,16 @@ export class PoolService {
             promiseWriteInStream({ maybePromise: this.#getHostsStatus(id), path: 'hosts.status', stream }),
             promiseWriteInStream({ maybePromise: this.#getVmsStatus(id), path: 'vms.status', stream }),
             promiseWriteInStream({ maybePromise: this.#getAlarms(id), path: 'alarms', stream }),
-            promiseWriteInStream({ maybePromise: this.#getMissingPatches(id), path: 'hosts.missingPatches', stream }),
+            promiseWriteInStream({
+                maybePromise: this.getMissingPatches(id).catch(err => {
+                    if (featureUnauthorized.is(err)) {
+                        return { hasAuthorization: false };
+                    }
+                    throw err;
+                }),
+                path: 'hosts.missingPatches',
+                stream,
+            }),
             promiseWriteInStream({ maybePromise: this.#getTopFiveSrsUsage(id), path: 'srs.topFiveUsage', stream }),
             promiseWriteInStream({ maybePromise: this.#getTopFiveHostsRamUsage(id), path: 'hosts.topFiveUsage.ram', stream }),
             promiseWriteInStream({ maybePromise: this.#getTopFiveHostsCpuUsage(id), path: 'hosts.topFiveUsage.cpu', stream }),

package/dist/proxies/proxy.controller.mjs

@@ -0,0 +1,61 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+import { Example, Get, Path, Query, Request, Response, Route, Security, Tags } from 'tsoa';
+import { provide } from 'inversify-binding-decorators';
+import { notFoundResp, unauthorizedResp } from '../open-api/common/response.common.mjs';
+import { partialProxies, proxy, proxyIds } from '../open-api/oa-examples/proxy.oa-example.mjs';
+import { XoController } from '../abstract-classes/xo-controller.mjs';
+let ProxyController = class ProxyController extends XoController {
+    getAllCollectionObjects() {
+        return this.restApi.xoApp.getAllProxies();
+    }
+    getCollectionObject(id) {
+        return this.restApi.xoApp.getProxy(id);
+    }
+    /**
+     * @example fields "vmUuid,id,name"
+     * @example filter "vmUuid?"
+     * @example limit 42
+     */
+    async getProxies(req, fields, ndjson, filter, limit) {
+        const proxies = Object.values(await this.getObjects({ filter, limit }));
+        return this.sendObjects(proxies, req);
+    }
+    /**
+     * @example id "e625ea0c-a876-405a-b838-109d762efe88"
+     */
+    getProxy(id) {
+        return this.getObject(id);
+    }
+};
+__decorate([
+    Example(proxyIds),
+    Example(partialProxies),
+    Get(''),
+    __param(0, Request()),
+    __param(1, Query()),
+    __param(2, Query()),
+    __param(3, Query()),
+    __param(4, Query())
+], ProxyController.prototype, "getProxies", null);
+__decorate([
+    Example(proxy),
+    Get('{id}'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path())
+], ProxyController.prototype, "getProxy", null);
+ProxyController = __decorate([
+    Route('proxies'),
+    Security('*'),
+    Response(unauthorizedResp.status, unauthorizedResp.description),
+    Tags('proxies'),
+    provide(ProxyController)
+], ProxyController);
+export { ProxyController };

package/dist/rest-api/rest-api.mjs

@@ -1,3 +1,4 @@
+import * as CM from 'complex-matcher';
 import { createLogger } from '@xen-orchestra/log';
 import { invalidCredentials } from 'xo-common/api-errors.js';
 const log = createLogger('xo:rest-api:error-handler');
@@ -31,8 +32,11 @@ export class RestApi {
     getObject(id, type) {
         return this.#xoApp.getObject(id, type);
     }
-    getObjectsByType(type, opts) {
-        return this.#xoApp.getObjectsByType(type, opts);
+    getObjectsByType(type, { filter, ...opts } = {}) {
+        if (filter !== undefined && typeof filter === 'string') {
+            filter = CM.parse(filter).createPredicate();
+        }
+        return this.#xoApp.getObjectsByType(type, { filter, ...opts });
     }
     getXapiObject(maybeId, type) {
         return this.#xoApp.getXapiObject(maybeId, type);

package/dist/restore-logs/restore-log.controller.mjs

@@ -0,0 +1,144 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+import { createLogger } from '@xen-orchestra/log';
+import { Deprecated, Example, Get, Middlewares, Path, Query, Request, Response, Route, Security, Tags } from 'tsoa';
+import { inject } from 'inversify';
+import { noSuchObject } from 'xo-common/api-errors.js';
+import { provide } from 'inversify-binding-decorators';
+import { BackupLogService } from '../backup-logs/backup-log.service.mjs';
+import { RestApi } from '../rest-api/rest-api.mjs';
+import { unauthorizedResp } from '../open-api/common/response.common.mjs';
+import { XoController } from '../abstract-classes/xo-controller.mjs';
+import { partialRestoreLogs, restoreLog, restoreLogIds } from '../open-api/oa-examples/restore-log.oa-example.mjs';
+const log = createLogger('xo:rest-api:restoreLog-controller');
+let RestoreLogController = class RestoreLogController extends XoController {
+    #backupLogService;
+    constructor(restApi, backupLogService) {
+        super(restApi);
+        this.#backupLogService = backupLogService;
+    }
+    getAllCollectionObjects() {
+        const filter = log => !this.#backupLogService.isBackupLog(log);
+        return this.restApi.xoApp.getBackupNgLogsSorted({ filter });
+    }
+    async getCollectionObject(id) {
+        const log = await this.restApi.xoApp.getBackupNgLogs(id);
+        if (this.#backupLogService.isBackupLog(log)) {
+            throw noSuchObject('restore-log');
+        }
+        return log;
+    }
+    /**
+     * @example fields "jobName,status,data"
+     * @example filter "status:success"
+     * @example limit 42
+     */
+    async getRestoreLogs(req, fields, ndjson, filter, limit) {
+        const restoreLogs = await this.getObjects({ filter, limit });
+        return this.sendObjects(Object.values(restoreLogs), req);
+    }
+    /**
+     * @example id "fo"
+     */
+    getRestoreLog(id) {
+        return this.getObject(id);
+    }
+};
+__decorate([
+    Example(restoreLogIds),
+    Example(partialRestoreLogs),
+    Get(''),
+    __param(0, Request()),
+    __param(1, Query()),
+    __param(2, Query()),
+    __param(3, Query()),
+    __param(4, Query())
+], RestoreLogController.prototype, "getRestoreLogs", null);
+__decorate([
+    Example(restoreLog),
+    Get('{id}'),
+    __param(0, Path())
+], RestoreLogController.prototype, "getRestoreLog", null);
+RestoreLogController = __decorate([
+    Route('restore-logs'),
+    Security('*'),
+    Response(unauthorizedResp.status, unauthorizedResp.description),
+    Tags('restore-logs'),
+    provide(RestoreLogController),
+    __param(0, inject(RestApi)),
+    __param(1, inject(BackupLogService))
+], RestoreLogController);
+export { RestoreLogController };
+// ----------- DEPRECATED TO BE REMOVED IN ONE YEAR  (09-12-2026)--------------------
+let DeprecatedRestoreController = class DeprecatedRestoreController extends XoController {
+    #backupLogService;
+    constructor(restApi, backupLogService) {
+        super(restApi);
+        this.#backupLogService = backupLogService;
+    }
+    getAllCollectionObjects() {
+        const filter = log => !this.#backupLogService.isBackupLog(log);
+        return this.restApi.xoApp.getBackupNgLogsSorted({ filter });
+    }
+    async getCollectionObject(id) {
+        const log = await this.restApi.xoApp.getBackupNgLogs(id);
+        if (this.#backupLogService.isBackupLog(log)) {
+            throw noSuchObject('restore-log');
+        }
+        return log;
+    }
+    /**
+     * @example fields "jobName,status,data"
+     * @example filter "status:success"
+     * @example limit 42
+     */
+    async getDeprecatedRestoreLogs(req, fields, ndjson, filter, limit) {
+        const restoreLogs = await this.getObjects({ filter, limit });
+        return this.sendObjects(Object.values(restoreLogs), req, 'restore-logs');
+    }
+    /**
+     * @example id "1758180544428"
+     */
+    getDeprecatedRestoreLog(id) {
+        return this.getObject(id);
+    }
+};
+__decorate([
+    Example(restoreLogIds),
+    Example(partialRestoreLogs),
+    Deprecated(),
+    Get(''),
+    __param(0, Request()),
+    __param(1, Query()),
+    __param(2, Query()),
+    __param(3, Query()),
+    __param(4, Query())
+], DeprecatedRestoreController.prototype, "getDeprecatedRestoreLogs", null);
+__decorate([
+    Example(restoreLog),
+    Deprecated(),
+    Get('{id}'),
+    __param(0, Path())
+], DeprecatedRestoreController.prototype, "getDeprecatedRestoreLog", null);
+DeprecatedRestoreController = __decorate([
+    Route('restore/logs'),
+    Security('*'),
+    Response(unauthorizedResp.status, unauthorizedResp.description),
+    Middlewares((_req, _res, next) => {
+        log.warn('You are calling a deprecated route. It will be removed in the futur. Please use `/rest/v0/restore-logs` instead');
+        next();
+    }),
+    Tags('restore-logs'),
+    provide(DeprecatedRestoreController),
+    __param(0, inject(RestApi)),
+    __param(1, inject(BackupLogService))
+], DeprecatedRestoreController);
+export { DeprecatedRestoreController };
+// ----------- DEPRECATED TO BE REMOVED IN ONE YEAR  (09-12-2026)--------------------

package/dist/srs/sr.controller.mjs

@@ -7,14 +7,17 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 var __param = (this && this.__param) || function (paramIndex, decorator) {
     return function (target, key) { decorator(target, key, paramIndex); }
 };
-import { Example, Get, Path, Query, Request, Response, Route, Security, Tags } from 'tsoa';
+import { Example, Get, Path, Post, Query, Request, Response, Route, Security, SuccessResponse, Tags } from 'tsoa';
 import { inject } from 'inversify';
 import { provide } from 'inversify-binding-decorators';
+import { SUPPORTED_VDI_FORMAT } from '@vates/types';
 import { AlarmService } from '../alarms/alarm.service.mjs';
+import { BASE_URL } from '../index.mjs';
 import { escapeUnsafeComplexMatcher } from '../helpers/utils.helper.mjs';
 import { genericAlarmsExample } from '../open-api/oa-examples/alarm.oa-example.mjs';
-import { notFoundResp, unauthorizedResp } from '../open-api/common/response.common.mjs';
+import { createdResp, notFoundResp, unauthorizedResp } from '../open-api/common/response.common.mjs';
 import { partialSrs, sr, srIds } from '../open-api/oa-examples/sr.oa-example.mjs';
+import { vdiId } from '../open-api/oa-examples/vdi.oa-example.mjs';
 import { RestApi } from '../rest-api/rest-api.mjs';
 import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
 let SrController = class SrController extends XapiXoController {
@@ -51,6 +54,28 @@ let SrController = class SrController extends XapiXoController {
         });
         return this.sendObjects(Object.values(alarms), req, 'alarms');
     }
+    /**
+     * Import an exported VDI
+     * @example id "c4284e12-37c9-7967-b9e8-83ef229c3e03"
+     * @example name_label "VDI_foo_import"
+     * @example name_description "VDI imported by the REST API"
+     * @example raw true
+     */
+    async srImportVdi(req, id, name_label, name_description, raw) {
+        const xapiSr = this.getXapiObject(id);
+        const xapi = xapiSr.$xapi;
+        if (req.headers['content-length'] !== undefined) {
+            req.length = +req.headers['content-length'];
+        }
+        const vdiRef = await xapi.SR_importVdi(xapiSr.$ref, req, {
+            format: raw ? SUPPORTED_VDI_FORMAT.raw : SUPPORTED_VDI_FORMAT.vhd,
+            name_label,
+            name_description,
+        });
+        const vdiId = await xapi.getField('VDI', vdiRef, 'uuid');
+        this.setHeader('Location', `${BASE_URL}/vdis/${vdiId}`);
+        return { id: vdiId };
+    }
 };
 __decorate([
     Example(srIds),
@@ -80,6 +105,18 @@ __decorate([
     __param(4, Query()),
     __param(5, Query())
 ], SrController.prototype, "getSrAlarms", null);
+__decorate([
+    Example(vdiId),
+    Post('{id}/vdis'),
+    Tags('vdis'),
+    SuccessResponse(createdResp.status, 'VDI imported'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Request()),
+    __param(1, Path()),
+    __param(2, Query()),
+    __param(3, Query()),
+    __param(4, Query())
+], SrController.prototype, "srImportVdi", null);
 SrController = __decorate([
     Route('srs'),
     Security('*'),

package/dist/tasks/task.controller.mjs

@@ -0,0 +1,167 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+import * as CM from 'complex-matcher';
+import { XoController } from '../abstract-classes/xo-controller.mjs';
+import { Get, Path, Query, Request, Route, Security, Tags, Response, Example, Delete, Post, SuccessResponse } from 'tsoa';
+import { asynchronousActionResp, badRequestResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
+import { provide } from 'inversify-binding-decorators';
+import { partialTasks, task, taskIds, taskLocation } from '../open-api/oa-examples/task.oa-example.mjs';
+import pDefer from 'promise-toolbox/defer';
+import { ApiError } from '../helpers/error.helper.mjs';
+import { Transform } from 'node:stream';
+import { makeObjectMapper } from '../helpers/object-wrapper.helper.mjs';
+let TaskController = class TaskController extends XoController {
+    async getAllCollectionObjects() {
+        const result = [];
+        for await (const task of this.restApi.tasks.list()) {
+            result.push(task);
+        }
+        return result;
+    }
+    getCollectionObject(id) {
+        return this.restApi.tasks.get(id);
+    }
+    /**
+     *
+     * If watch is true, ndjson must also be true
+     *
+     * @example fields "status,id,properties"
+     * @example filter "status:failure"
+     * @example limit 42
+     */
+    async getTasks(req, fields, ndjson, watch, filter, limit) {
+        if (watch) {
+            if (!ndjson) {
+                throw new ApiError('watch=true requires ndjson=true', 400);
+            }
+            const userFilter = filter === undefined ? undefined : CM.parse(filter).createPredicate();
+            const stream = new Transform({
+                objectMode: true,
+                transform([event, object], encoding, callback) {
+                    const mapper = makeObjectMapper(req);
+                    callback(null, JSON.stringify([event, mapper(object)]) + '\n');
+                },
+            });
+            stream.on('close', () => {
+                this.restApi.tasks.off('update', update).off('remove', remove);
+            });
+            req.on('close', () => {
+                stream.destroy();
+            });
+            process.on('SIGTERM', () => {
+                req.destroy();
+            });
+            function update(task) {
+                if (userFilter === undefined || userFilter(task)) {
+                    stream.write(['update', task]);
+                }
+            }
+            function remove(taskId) {
+                stream.write(['remove', { id: taskId }]);
+            }
+            this.restApi.tasks.on('update', update).on('remove', remove);
+            return stream;
+        }
+        const tasks = Object.values(await this.getObjects({ filter, limit }));
+        return this.sendObjects(tasks, req);
+    }
+    /**
+     * @example id "0mdd1basu"
+     */
+    async getTask(req, id, wait) {
+        const taskId = id;
+        if (wait) {
+            const { promise, resolve } = pDefer();
+            const stopWatch = await this.restApi.tasks.watch(taskId, task => {
+                if (task.status !== 'pending') {
+                    stopWatch();
+                    resolve(task);
+                }
+            });
+            req.on('close', stopWatch);
+            return promise;
+        }
+        return this.getObject(taskId);
+    }
+    async deleteTasks() {
+        await this.restApi.tasks.clearLogs();
+    }
+    /**
+     * @example id "0mdd1basu"
+     */
+    async deleteTask(id) {
+        const task = await this.getObject(id);
+        await this.restApi.tasks.deleteLog(task.id);
+    }
+    /**
+     * @example id "0mdd1basu"
+     */
+    async abortTask(id, sync) {
+        const taskId = id;
+        const action = async () => {
+            await this.restApi.tasks.abort(taskId);
+        };
+        return this.createAction(action, {
+            sync,
+            statusCode: noContentResp.status,
+            taskProperties: {
+                name: 'abort task',
+                objectId: taskId,
+            },
+        });
+    }
+};
+__decorate([
+    Example(taskIds),
+    Example(partialTasks),
+    Get(''),
+    Response(badRequestResp.status, badRequestResp.description),
+    __param(0, Request()),
+    __param(1, Query()),
+    __param(2, Query()),
+    __param(3, Query()),
+    __param(4, Query()),
+    __param(5, Query())
+], TaskController.prototype, "getTasks", null);
+__decorate([
+    Example(task),
+    Get('{id}'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Request()),
+    __param(1, Path()),
+    __param(2, Query())
+], TaskController.prototype, "getTask", null);
+__decorate([
+    Delete(''),
+    SuccessResponse(noContentResp.status, noContentResp.description)
+], TaskController.prototype, "deleteTasks", null);
+__decorate([
+    Delete('{id}'),
+    SuccessResponse(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path())
+], TaskController.prototype, "deleteTask", null);
+__decorate([
+    Example(taskLocation),
+    Post('{id}/actions/abort'),
+    SuccessResponse(asynchronousActionResp.status, asynchronousActionResp.description, asynchronousActionResp.produce),
+    Response(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path()),
+    __param(1, Query())
+], TaskController.prototype, "abortTask", null);
+TaskController = __decorate([
+    Route('tasks'),
+    Security('*'),
+    Response(unauthorizedResp.status, unauthorizedResp.description),
+    Tags('tasks'),
+    provide(TaskController)
+], TaskController);
+export { TaskController };

package/dist/tasks/task.service.mjs

@@ -0,0 +1,24 @@
+import * as CM from 'complex-matcher';
+export class TaskService {
+    #restApi;
+    constructor(restApi) {
+        this.#restApi = restApi;
+    }
+    async getTasks({ filter, limit = Infinity } = {}) {
+        const tasks = [];
+        let userFilter = () => true;
+        if (filter !== undefined) {
+            userFilter = typeof filter === 'string' ? CM.parse(filter).createPredicate() : filter;
+        }
+        for await (const task of this.#restApi.tasks.list()) {
+            if (limit === 0) {
+                break;
+            }
+            if (userFilter(task)) {
+                tasks.push(task);
+                limit--;
+            }
+        }
+        return tasks;
+    }
+}