@xen-orchestra/rest-api 0.12.0 → 0.13.0

package/dist/users/user.controller.mjs

@@ -7,10 +7,11 @@ 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 { Body, Delete, Example, Get, Middlewares, Path, Post, Query, Request, Response, Route, Security, SuccessResponse, Tags, } from 'tsoa';
+import { Body, Delete, Example, Get, Middlewares, Patch, Path, Post, Query, Request, Response, Route, Security, SuccessResponse, Tags, } from 'tsoa';
 import { json } from 'express';
 import { provide } from 'inversify-binding-decorators';
-import { createdResp, invalidParameters, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
+import { createdResp, forbiddenOperationResp, invalidParameters, noContentResp, notFoundResp, resourceAlreadyExists, unauthorizedResp, } from '../open-api/common/response.common.mjs';
+import { forbiddenOperation } from 'xo-common/api-errors.js';
 import { partialUsers, user, userId, userIds } from '../open-api/oa-examples/user.oa-example.mjs';
 import { XoController } from '../abstract-classes/xo-controller.mjs';
 let UserController = class UserController extends XoController {
@@ -45,6 +46,37 @@ let UserController = class UserController extends XoController {
     getUser(id) {
         return this.getObject(id);
     }
+    /**
+     * @example id "722d17b9-699b-49d2-8193-be1ac573d3de"
+     * @example body {
+     *   "name": "updated user name",
+     *   "password": "newP4ssword",
+     *   "permission": "admin",
+     *   "preferences": {}
+     *  }
+     */
+    async updateUser(id, body) {
+        const currentUser = this.restApi.getCurrentUser();
+        if (currentUser === undefined) {
+            throw new Error('current user is not defined');
+        }
+        const isAdmin = currentUser.permission === 'admin';
+        if (isAdmin) {
+            if (body.permission !== undefined && currentUser.id === id) {
+                throw forbiddenOperation('update user', 'cannot change own permission');
+            }
+        }
+        else if (body.name !== undefined || body.password !== undefined || body.permission !== undefined) {
+            throw forbiddenOperation('update user', 'cannot change these fields without admin rights');
+        }
+        const user = await this.getObject(id);
+        if (user.authProviders !== undefined &&
+            Object.keys(user.authProviders).length > 0 &&
+            (body.name !== undefined || body.password !== undefined)) {
+            throw forbiddenOperation('update user', 'cannot change name or password of synchronized user');
+        }
+        await this.restApi.xoApp.updateUser(user.id, body);
+    }
     /**
      * @example body { "name": "new user", "password": "password", "permission": "none" }
      */
@@ -75,6 +107,16 @@ __decorate([
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Path())
 ], UserController.prototype, "getUser", null);
+__decorate([
+    Patch('{id}'),
+    Middlewares(json()),
+    SuccessResponse(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(resourceAlreadyExists.status, resourceAlreadyExists.description),
+    Response(forbiddenOperationResp.status, forbiddenOperationResp.description),
+    __param(0, Path()),
+    __param(1, Body())
+], UserController.prototype, "updateUser", null);
 __decorate([
     Example(userId),
     Post(''),

package/dist/users/user.type.mjs

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

package/dist/vbds/vbd.controller.mjs

@@ -10,13 +10,18 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
 import { Example, Get, Path, Query, Request, Response, Route, Security, Tags } from 'tsoa';
 import { inject } from 'inversify';
 import { provide } from 'inversify-binding-decorators';
+import { AlarmService } from '../alarms/alarm.service.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 { partialVbds, vbd, vbdIds } from '../open-api/oa-examples/vbd.oa-example.mjs';
 import { RestApi } from '../rest-api/rest-api.mjs';
 import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
 let VbdController = class VbdController extends XapiXoController {
-    constructor(restApi) {
+    #alarmService;
+    constructor(restApi, alarmService) {
         super('VBD', restApi);
+        this.#alarmService = alarmService;
     }
     /**
      *
@@ -34,6 +39,20 @@ let VbdController = class VbdController extends XapiXoController {
     getVbd(id) {
         return this.getObject(id);
     }
+    /**
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     * @example fields "id,time"
+     * @example filter "time:>1747053793"
+     * @example limit 42
+     */
+    getVbdAlarms(req, id, fields, ndjson, filter, limit) {
+        const vbd = this.getObject(id);
+        const alarms = this.#alarmService.getAlarms({
+            filter: `${escapeUnsafeComplexMatcher(filter) ?? ''} object:uuid:${vbd.uuid}`,
+            limit,
+        });
+        return this.sendObjects(Object.values(alarms), req, 'alarms');
+    }
 };
 __decorate([
     Example(vbdIds),
@@ -51,12 +70,25 @@ __decorate([
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Path())
 ], VbdController.prototype, "getVbd", null);
+__decorate([
+    Example(genericAlarmsExample),
+    Get('{id}/alarms'),
+    Tags('alarms'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Request()),
+    __param(1, Path()),
+    __param(2, Query()),
+    __param(3, Query()),
+    __param(4, Query()),
+    __param(5, Query())
+], VbdController.prototype, "getVbdAlarms", null);
 VbdController = __decorate([
     Route('vbds'),
     Security('*'),
     Response(unauthorizedResp.status, unauthorizedResp.description),
     Tags('vbds'),
     provide(VbdController),
-    __param(0, inject(RestApi))
+    __param(0, inject(RestApi)),
+    __param(1, inject(AlarmService))
 ], VbdController);
 export { VbdController };

package/dist/vifs/vif.controller.mjs

@@ -9,14 +9,19 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
 };
 import { Example, Get, Path, Query, Request, Response, Route, Security, Tags } from 'tsoa';
 import { inject } from 'inversify';
+import { escapeUnsafeComplexMatcher } from '../helpers/utils.helper.mjs';
 import { provide } from 'inversify-binding-decorators';
 import { RestApi } from '../rest-api/rest-api.mjs';
 import { notFoundResp, unauthorizedResp } from '../open-api/common/response.common.mjs';
 import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
 import { partialVifs, vif, vifIds } from '../open-api/oa-examples/vif.oa-example.mjs';
+import { genericAlarmsExample } from '../open-api/oa-examples/alarm.oa-example.mjs';
+import { AlarmService } from '../alarms/alarm.service.mjs';
 let VifController = class VifController extends XapiXoController {
-    constructor(restApi) {
+    #alarmService;
+    constructor(restApi, alarmService) {
         super('VIF', restApi);
+        this.#alarmService = alarmService;
     }
     /**
      * @example fields "attached,id,device"
@@ -32,6 +37,20 @@ let VifController = class VifController extends XapiXoController {
     getVif(id) {
         return this.getObject(id);
     }
+    /**
+     * @example id "f028c5d4-578a-332c-394e-087aaca32dd3"
+     * @example fields "id,time"
+     * @example filter "time:>1747053793"
+     * @example limit 42
+     */
+    getVifAlarms(req, id, fields, ndjson, filter, limit) {
+        const vif = this.getObject(id);
+        const alarms = this.#alarmService.getAlarms({
+            filter: `${escapeUnsafeComplexMatcher(filter) ?? ''} object:uuid:${vif.uuid}`,
+            limit,
+        });
+        return this.sendObjects(Object.values(alarms), req, 'alarms');
+    }
 };
 __decorate([
     Example(vifIds),
@@ -49,12 +68,25 @@ __decorate([
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Path())
 ], VifController.prototype, "getVif", null);
+__decorate([
+    Example(genericAlarmsExample),
+    Get('{id}/alarms'),
+    Tags('alarms'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Request()),
+    __param(1, Path()),
+    __param(2, Query()),
+    __param(3, Query()),
+    __param(4, Query()),
+    __param(5, Query())
+], VifController.prototype, "getVifAlarms", null);
 VifController = __decorate([
     Route('vifs'),
     Security('*'),
     Response(unauthorizedResp.status, unauthorizedResp.description),
     Tags('vifs'),
     provide(VifController),
-    __param(0, inject(RestApi))
+    __param(0, inject(RestApi)),
+    __param(1, inject(AlarmService))
 ], VifController);
 export { VifController };

package/dist/vm-controller/vm-controller.controller.mjs

@@ -11,12 +11,17 @@ import { inject } from 'inversify';
 import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
 import { RestApi } from '../rest-api/rest-api.mjs';
 import { Example, Get, Path, Query, Request, Response, Route, Security, Tags } from 'tsoa';
+import { AlarmService } from '../alarms/alarm.service.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 { provide } from 'inversify-binding-decorators';
 import { partialVmControllers, vmController, vmControllerIds, } from '../open-api/oa-examples/vm-controller.oa-example.mjs';
 let VmControllerController = class VmControllerController extends XapiXoController {
-    constructor(restApi) {
+    #alarmService;
+    constructor(restApi, alarmService) {
         super('VM-controller', restApi);
+        this.#alarmService = alarmService;
     }
     /**
      *
@@ -33,6 +38,20 @@ let VmControllerController = class VmControllerController extends XapiXoControll
     getVmController(id) {
         return this.getObject(id);
     }
+    /**
+     * @example id "9b4775bd-9493-490a-9afa-f786a44caa4f"
+     * @example fields "id,time"
+     * @example filter "time:>1747053793"
+     * @example limit 42
+     */
+    getVmControllerAlarms(req, id, fields, ndjson, filter, limit) {
+        const vmController = this.getObject(id);
+        const alarms = this.#alarmService.getAlarms({
+            filter: `${escapeUnsafeComplexMatcher(filter) ?? ''} object:uuid:${vmController.uuid}`,
+            limit,
+        });
+        return this.sendObjects(Object.values(alarms), req, 'alarms');
+    }
 };
 __decorate([
     Example(vmControllerIds),
@@ -50,12 +69,25 @@ __decorate([
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Path())
 ], VmControllerController.prototype, "getVmController", null);
+__decorate([
+    Example(genericAlarmsExample),
+    Get('{id}/alarms'),
+    Tags('alarms'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Request()),
+    __param(1, Path()),
+    __param(2, Query()),
+    __param(3, Query()),
+    __param(4, Query()),
+    __param(5, Query())
+], VmControllerController.prototype, "getVmControllerAlarms", null);
 VmControllerController = __decorate([
     Route('vm-controllers'),
     Security('*'),
     Response(unauthorizedResp.status, unauthorizedResp.description),
     Tags('vms'),
     provide(VmControllerController),
-    __param(0, inject(RestApi))
+    __param(0, inject(RestApi)),
+    __param(1, inject(AlarmService))
 ], VmControllerController);
 export { VmControllerController };

package/dist/vm-snapshots/vm-snapshot.controller.mjs

@@ -9,14 +9,19 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
 };
 import { Example, Get, Path, Query, Request, Response, Route, Security, Tags } from 'tsoa';
 import { inject } from 'inversify';
+import { AlarmService } from '../alarms/alarm.service.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 { RestApi } from '../rest-api/rest-api.mjs';
 import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
 import { provide } from 'inversify-binding-decorators';
 import { partialVmSnapshots, vmSnapshot, vmSnapshotIds } from '../open-api/oa-examples/vm-snapshot.oa-example.mjs';
 let VmSnapshotController = class VmSnapshotController extends XapiXoController {
-    constructor(restApi) {
+    #alarmService;
+    constructor(restApi, alarmService) {
         super('VM-snapshot', restApi);
+        this.#alarmService = alarmService;
     }
     /**
      *
@@ -33,6 +38,20 @@ let VmSnapshotController = class VmSnapshotController extends XapiXoController {
     getVmSnapshot(id) {
         return this.getObject(id);
     }
+    /**
+     * @example id "d68fca2c-41e6-be87-d790-105c1642a090"
+     * @example fields "id,time"
+     * @example filter "time:>1747053793"
+     * @example limit 42
+     */
+    getVmSnapshotAlarms(req, id, fields, ndjson, filter, limit) {
+        const vmSnapshot = this.getObject(id);
+        const alarms = this.#alarmService.getAlarms({
+            filter: `${escapeUnsafeComplexMatcher(filter) ?? ''} object:uuid:${vmSnapshot.uuid}`,
+            limit,
+        });
+        return this.sendObjects(Object.values(alarms), req, 'alarms');
+    }
 };
 __decorate([
     Example(vmSnapshotIds),
@@ -50,12 +69,25 @@ __decorate([
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Path())
 ], VmSnapshotController.prototype, "getVmSnapshot", null);
+__decorate([
+    Example(genericAlarmsExample),
+    Get('{id}/alarms'),
+    Tags('alarms'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Request()),
+    __param(1, Path()),
+    __param(2, Query()),
+    __param(3, Query()),
+    __param(4, Query()),
+    __param(5, Query())
+], VmSnapshotController.prototype, "getVmSnapshotAlarms", null);
 VmSnapshotController = __decorate([
     Route('vm-snapshots'),
     Security('*'),
     Response(unauthorizedResp.status, unauthorizedResp.description),
     Tags('vms'),
     provide(VmSnapshotController),
-    __param(0, inject(RestApi))
+    __param(0, inject(RestApi)),
+    __param(1, inject(AlarmService))
 ], VmSnapshotController);
 export { VmSnapshotController };

package/dist/vms/vm.controller.mjs

@@ -11,16 +11,21 @@ import { Example, Get, Path, Post, Query, Request, Response, Route, Security, Ta
 import { inject } from 'inversify';
 import { incorrectState, invalidParameters } from 'xo-common/api-errors.js';
 import { provide } from 'inversify-binding-decorators';
+import { AlarmService } from '../alarms/alarm.service.mjs';
 import { asynchronousActionResp, createdResp, internalServerErrorResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.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 { partialVms, vm, vmIds, vmStatsExample } from '../open-api/oa-examples/vm.oa-example.mjs';
 import { RestApi } from '../rest-api/rest-api.mjs';
 import { taskLocation } from '../open-api/oa-examples/task.oa-example.mjs';
 import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
 const IGNORED_VDIS_TAG = '[NOSNAP]';
 let VmController = class VmController extends XapiXoController {
-    constructor(restApi) {
+    #alarmService;
+    constructor(restApi, alarmService) {
         super('VM', restApi);
+        this.#alarmService = alarmService;
     }
     /**
      *
@@ -294,6 +299,20 @@ let VmController = class VmController extends XapiXoController {
             },
         });
     }
+    /**
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     * @example fields "id,time"
+     * @example filter "time:>1747053793"
+     * @example limit 42
+     */
+    getVmAlarms(req, id, fields, ndjson, filter, limit) {
+        const vm = this.getObject(id);
+        const alarms = this.#alarmService.getAlarms({
+            filter: `${escapeUnsafeComplexMatcher(filter) ?? ''} object:uuid:${vm.uuid}`,
+            limit,
+        });
+        return this.sendObjects(Object.values(alarms), req, 'alarms');
+    }
 };
 __decorate([
     Example(vmIds),
@@ -433,6 +452,18 @@ __decorate([
     __param(1, Body()),
     __param(2, Query())
 ], VmController.prototype, "snapshotVm", null);
+__decorate([
+    Example(genericAlarmsExample),
+    Get('{id}/alarms'),
+    Tags('alarms'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Request()),
+    __param(1, Path()),
+    __param(2, Query()),
+    __param(3, Query()),
+    __param(4, Query()),
+    __param(5, Query())
+], VmController.prototype, "getVmAlarms", null);
 VmController = __decorate([
     Route('vms'),
     Security('*'),
@@ -442,6 +473,7 @@ VmController = __decorate([
     // It automatically bind the class to the IOC container that handles dependency injection
     ,
     provide(VmController),
-    __param(0, inject(RestApi))
+    __param(0, inject(RestApi)),
+    __param(1, inject(AlarmService))
 ], VmController);
 export { VmController };