@xen-orchestra/rest-api 0.1.0

package/README.md

@@ -0,0 +1,74 @@
+<!-- DO NOT EDIT MANUALLY, THIS FILE HAS BEEN GENERATED -->
+
+# @xen-orchestra/rest-api
+
+[![Package Version](https://badgen.net/npm/v/@xen-orchestra/rest-api)](https://npmjs.org/package/@xen-orchestra/rest-api) ![License](https://badgen.net/npm/license/@xen-orchestra/rest-api) [![PackagePhobia](https://badgen.net/bundlephobia/minzip/@xen-orchestra/rest-api)](https://bundlephobia.com/result?p=@xen-orchestra/rest-api) [![Node compatibility](https://badgen.net/npm/node/@xen-orchestra/rest-api)](https://npmjs.org/package/@xen-orchestra/rest-api)
+
+> REST API to manage your XOA
+
+## Install
+
+Installation of the [npm package](https://npmjs.org/package/@xen-orchestra/rest-api):
+
+```sh
+npm install --save @xen-orchestra/rest-api
+```
+
+## Usage
+
+# @xen-orchestra/rest-api
+
+## Rules
+
+The REST API is based on the `TSOA` framework and therefore we use decorators a lot to define the behavior of a route or a group of routes. To keep things easily visible, it is best to always use the decorators in the same order.
+
+### Class decorator
+
+```ts
+@Routes('foo')
+@Security('*')
+@Response(401)
+@provide(Foo)
+class Foo extends Controller {}
+```
+
+### Methods decorator
+
+```ts
+@Routes('foo')
+...
+class Foo extends Controller {
+
+
+ /**
+  * any jsdoc anotations
+  * @example id 1234
+  */
+ @Example(['foo', 'bar'])
+ @Get('{id}')
+ @Security('*')
+ @Response(404)
+ getFoo(@Path() id: string) {
+    return this.getFoo(id)
+ }
+}
+```
+
+### Examples
+
+In order not to pollute important decorators, all example structures should be in a separate file. `src/open-api/examples/<resource>.example.mts`
+
+## Contributions
+
+Contributions are _very_ welcomed, either on the documentation or on
+the code.
+
+You may:
+
+- report any [issue](https://github.com/vatesfr/xen-orchestra/issues)
+  you've encountered;
+- fork and create a pull request.
+
+## License
+
+[AGPL-3.0-or-later](https://spdx.org/licenses/AGPL-3.0-or-later) © [Vates SAS](https://vates.fr)

package/dist/abstract-classes/xapi-xo-controller.mjs

@@ -0,0 +1,26 @@
+import * as CM from 'complex-matcher';
+import { Controller } from 'tsoa';
+import { makeObjectMapper } from '../helpers/object-wrapper.helper.mjs';
+export class XapiXoController extends Controller {
+    #type;
+    restApi;
+    constructor(type, restApi) {
+        super();
+        this.#type = type;
+        this.restApi = restApi;
+    }
+    getObjects({ filter, limit } = {}) {
+        if (filter !== undefined) {
+            filter = CM.parse(filter).createPredicate();
+        }
+        return this.restApi.getObjectsByType(this.#type, { filter, limit });
+    }
+    getObject(id) {
+        return this.restApi.getObject(id, this.#type);
+    }
+    sendObjects(objects, req) {
+        const mapper = makeObjectMapper(req);
+        const mappedObjects = objects.map(mapper);
+        return mappedObjects;
+    }
+}

package/dist/helpers/helper.type.mjs

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

package/dist/helpers/object-wrapper.helper.mjs

@@ -0,0 +1,28 @@
+import path from 'node:path';
+import pick from 'lodash/pick.js';
+const { join } = path.posix;
+export function makeObjectMapper(req, path = req.path) {
+    const makeUrl = ({ id }) => join(baseUrl, path, typeof id === 'number' ? String(id) : id);
+    let objectMapper;
+    const { query, baseUrl } = req;
+    const { fields } = query;
+    if (fields === '*') {
+        objectMapper = object => ({
+            ...object,
+            href: makeUrl(object),
+        });
+    }
+    else if (typeof fields === 'string') {
+        const _fields = fields.split(',');
+        objectMapper = object => {
+            const url = makeUrl(object);
+            return { ...pick(object, _fields), href: url };
+        };
+    }
+    else {
+        objectMapper = makeUrl;
+    }
+    return function (obj) {
+        return objectMapper(obj);
+    };
+}

package/dist/index.mjs

@@ -0,0 +1,20 @@
+import * as swaggerUi from 'swagger-ui-express';
+import { createRequire } from 'module';
+import genericErrorHandler from './middlewares/generic-error-handler.middleware.mjs';
+import tsoaToXoErrorHandler from './middlewares/tsoa-to-xo-error.middleware.mjs';
+import { RegisterRoutes } from './open-api/routes/routes.js';
+import { setupContainer } from './ioc/ioc.mjs';
+// Avoid using "import from" to import a json file as this requires assert/with and will break compatibility with recent node versions
+// https://github.com/nodejs/node/issues/51622
+const require = createRequire(import.meta.url);
+const swaggerOpenApiSpec = require('../open-api/spec/swagger.json');
+export default function setupRestApi(express, xoApp) {
+    setupContainer(xoApp);
+    RegisterRoutes(express);
+    // do not register the doc at the root level, or it may lead to unwated behaviour
+    // uncomment when all endpoints are migrated to this API
+    // express.get('/rest/v0', (_req, res) => res.redirect('/rest/v0/docs'))
+    express.use('/rest/v0/docs', swaggerUi.serve, swaggerUi.setup(swaggerOpenApiSpec));
+    express.use('/rest/v0', tsoaToXoErrorHandler);
+    express.use('/rest/v0', genericErrorHandler);
+}

package/dist/ioc/ioc.mjs

@@ -0,0 +1,17 @@
+import { buildProviderModule } from 'inversify-binding-decorators';
+import { Container, decorate, injectable } from 'inversify';
+import { Controller } from 'tsoa';
+import { RestApi } from '../rest-api/rest-api.mjs';
+const iocContainer = new Container();
+decorate(injectable(), Controller);
+iocContainer.load(buildProviderModule());
+export function setupContainer(xoApp) {
+    if (iocContainer.isBound(RestApi)) {
+        iocContainer.unbind(RestApi);
+    }
+    iocContainer
+        .bind(RestApi)
+        .toDynamicValue(() => new RestApi(xoApp))
+        .inSingletonScope();
+}
+export { iocContainer };

package/dist/middlewares/authentication.middleware.mjs

@@ -0,0 +1,34 @@
+import { createLogger } from '@xen-orchestra/log';
+import { invalidCredentials, notImplemented, unauthorized } from 'xo-common/api-errors.js';
+import { iocContainer } from '../ioc/ioc.mjs';
+import { RestApi } from '../rest-api/rest-api.mjs';
+const noop = () => { };
+const log = createLogger('xo:rest-api:authentication');
+function getCredentials(securityName, req) {
+    const token = req.cookies.token ?? req.cookies.authenticationToken;
+    if (securityName === '*' || securityName === 'token') {
+        if (token !== undefined) {
+            return { token };
+        }
+        return;
+    }
+    log.error(`${securityName} not implemented.`);
+    throw notImplemented();
+}
+// TODO: correctly handle ACL/Resource set users
+// for now only support "xoa-admin"
+export async function expressAuthentication(req, securityName) {
+    const restApi = iocContainer.get(RestApi);
+    const ip = req.ip;
+    const credentials = getCredentials(securityName, req);
+    if (credentials === undefined) {
+        throw invalidCredentials();
+    }
+    const { user } = await restApi.authenticateUser(credentials, { ip });
+    if (user.permission !== 'admin') {
+        log.error(`The REST API can only be used by 'xoa-admin' users for now. Your permission: ${user.permission}`);
+        throw unauthorized();
+    }
+    await restApi.runWithApiContext(user, noop);
+    Promise.resolve(user);
+}

package/dist/middlewares/generic-error-handler.middleware.mjs

@@ -0,0 +1,33 @@
+import { createLogger } from '@xen-orchestra/log';
+import { featureUnauthorized, forbiddenOperation, invalidCredentials, invalidParameters, noSuchObject, notImplemented, unauthorized, } from 'xo-common/api-errors.js';
+const log = createLogger('xo:rest-api:error-handler');
+// must have 4 parameters to be recognized as an error middleware by express
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export default function genericErrorHandler(error, req, res, _next) {
+    if (!(error instanceof Error)) {
+        log.error(error);
+        res.status(500).json({ error });
+        return;
+    }
+    if (noSuchObject.is(error)) {
+        res.status(404);
+    }
+    else if (unauthorized.is(error) || forbiddenOperation.is(error) || featureUnauthorized.is(error)) {
+        res.status(403);
+    }
+    else if (invalidCredentials.is(error)) {
+        res.status(401);
+    }
+    else if (invalidParameters.is(error)) {
+        res.status(422);
+    }
+    else if (notImplemented.is(error)) {
+        res.status(501);
+    }
+    else {
+        res.status(500);
+        log.error(error);
+    }
+    log.info(`[${req.method}] ${req.path} (${res.statusCode})`);
+    res.json({ error: error.message });
+}

package/dist/middlewares/tsoa-to-xo-error.middleware.mjs

@@ -0,0 +1,8 @@
+import { invalidParameters } from 'xo-common/api-errors.js';
+import { ValidateError } from 'tsoa';
+export default function tsoaToXoErrorHandler(error, _req, _res, next) {
+    if (error instanceof ValidateError) {
+        /* throw */ invalidParameters(error.fields);
+    }
+    return next(error);
+}

package/dist/open-api/routes/routes.js

@@ -0,0 +1,181 @@
+import { fetchMiddlewares, ExpressTemplateService } from '@tsoa/runtime';
+// WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+import { VmController } from './../../vms/vm.controller.mjs';
+import { expressAuthentication } from './../../middlewares/authentication.middleware.mjs';
+// @ts-ignore - no great way to install types from subpackage
+import { iocContainer } from './../../ioc/ioc.mjs';
+const expressAuthenticationRecasted = expressAuthentication;
+// WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+const models = {
+    "Record_string.string_": {
+        "dataType": "refAlias",
+        "type": { "dataType": "nestedObjectLiteral", "nestedProperties": {}, "additionalProperties": { "dataType": "string" }, "validators": {} },
+    },
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+    "Record_VM_OPERATIONS.string_": {
+        "dataType": "refAlias",
+        "type": { "dataType": "nestedObjectLiteral", "nestedProperties": { "assert_operation_valid": { "dataType": "string", "required": true }, "awaiting_memory_live": { "dataType": "string", "required": true }, "call_plugin": { "dataType": "string", "required": true }, "changing_dynamic_range": { "dataType": "string", "required": true }, "changing_memory_limits": { "dataType": "string", "required": true }, "changing_memory_live": { "dataType": "string", "required": true }, "changing_NVRAM": { "dataType": "string", "required": true }, "changing_shadow_memory": { "dataType": "string", "required": true }, "changing_shadow_memory_live": { "dataType": "string", "required": true }, "changing_static_range": { "dataType": "string", "required": true }, "changing_VCPUs": { "dataType": "string", "required": true }, "changing_VCPUs_live": { "dataType": "string", "required": true }, "checkpoint": { "dataType": "string", "required": true }, "clean_reboot": { "dataType": "string", "required": true }, "clean_shutdown": { "dataType": "string", "required": true }, "clone": { "dataType": "string", "required": true }, "copy": { "dataType": "string", "required": true }, "create_template": { "dataType": "string", "required": true }, "create_vtpm": { "dataType": "string", "required": true }, "csvm": { "dataType": "string", "required": true }, "data_source_op": { "dataType": "string", "required": true }, "destroy": { "dataType": "string", "required": true }, "export": { "dataType": "string", "required": true }, "get_boot_record": { "dataType": "string", "required": true }, "hard_reboot": { "dataType": "string", "required": true }, "hard_shutdown": { "dataType": "string", "required": true }, "import": { "dataType": "string", "required": true }, "make_into_template": { "dataType": "string", "required": true }, "metadata_export": { "dataType": "string", "required": true }, "migrate_send": { "dataType": "string", "required": true }, "pause": { "dataType": "string", "required": true }, "pool_migrate": { "dataType": "string", "required": true }, "power_state_reset": { "dataType": "string", "required": true }, "provision": { "dataType": "string", "required": true }, "query_services": { "dataType": "string", "required": true }, "resume": { "dataType": "string", "required": true }, "resume_on": { "dataType": "string", "required": true }, "revert": { "dataType": "string", "required": true }, "reverting": { "dataType": "string", "required": true }, "send_sysrq": { "dataType": "string", "required": true }, "send_trigger": { "dataType": "string", "required": true }, "shutdown": { "dataType": "string", "required": true }, "snapshot": { "dataType": "string", "required": true }, "snapshot_with_quiesce": { "dataType": "string", "required": true }, "start": { "dataType": "string", "required": true }, "start_on": { "dataType": "string", "required": true }, "suspend": { "dataType": "string", "required": true }, "unpause": { "dataType": "string", "required": true }, "update_allowed_operations": { "dataType": "string", "required": true } }, "validators": {} },
+    },
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+    "VM_OPERATIONS": {
+        "dataType": "refAlias",
+        "type": { "dataType": "union", "subSchemas": [{ "dataType": "enum", "enums": ["assert_operation_valid"] }, { "dataType": "enum", "enums": ["awaiting_memory_live"] }, { "dataType": "enum", "enums": ["call_plugin"] }, { "dataType": "enum", "enums": ["changing_dynamic_range"] }, { "dataType": "enum", "enums": ["changing_memory_limits"] }, { "dataType": "enum", "enums": ["changing_memory_live"] }, { "dataType": "enum", "enums": ["changing_NVRAM"] }, { "dataType": "enum", "enums": ["changing_shadow_memory"] }, { "dataType": "enum", "enums": ["changing_shadow_memory_live"] }, { "dataType": "enum", "enums": ["changing_static_range"] }, { "dataType": "enum", "enums": ["changing_VCPUs"] }, { "dataType": "enum", "enums": ["changing_VCPUs_live"] }, { "dataType": "enum", "enums": ["checkpoint"] }, { "dataType": "enum", "enums": ["clean_reboot"] }, { "dataType": "enum", "enums": ["clean_shutdown"] }, { "dataType": "enum", "enums": ["clone"] }, { "dataType": "enum", "enums": ["copy"] }, { "dataType": "enum", "enums": ["create_template"] }, { "dataType": "enum", "enums": ["create_vtpm"] }, { "dataType": "enum", "enums": ["csvm"] }, { "dataType": "enum", "enums": ["data_source_op"] }, { "dataType": "enum", "enums": ["destroy"] }, { "dataType": "enum", "enums": ["export"] }, { "dataType": "enum", "enums": ["get_boot_record"] }, { "dataType": "enum", "enums": ["hard_reboot"] }, { "dataType": "enum", "enums": ["hard_shutdown"] }, { "dataType": "enum", "enums": ["import"] }, { "dataType": "enum", "enums": ["make_into_template"] }, { "dataType": "enum", "enums": ["metadata_export"] }, { "dataType": "enum", "enums": ["migrate_send"] }, { "dataType": "enum", "enums": ["pause"] }, { "dataType": "enum", "enums": ["pool_migrate"] }, { "dataType": "enum", "enums": ["power_state_reset"] }, { "dataType": "enum", "enums": ["provision"] }, { "dataType": "enum", "enums": ["query_services"] }, { "dataType": "enum", "enums": ["resume"] }, { "dataType": "enum", "enums": ["resume_on"] }, { "dataType": "enum", "enums": ["revert"] }, { "dataType": "enum", "enums": ["reverting"] }, { "dataType": "enum", "enums": ["send_sysrq"] }, { "dataType": "enum", "enums": ["send_trigger"] }, { "dataType": "enum", "enums": ["shutdown"] }, { "dataType": "enum", "enums": ["snapshot"] }, { "dataType": "enum", "enums": ["snapshot_with_quiesce"] }, { "dataType": "enum", "enums": ["start"] }, { "dataType": "enum", "enums": ["start_on"] }, { "dataType": "enum", "enums": ["suspend"] }, { "dataType": "enum", "enums": ["unpause"] }, { "dataType": "enum", "enums": ["update_allowed_operations"] }], "validators": {} },
+    },
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+    "Record_string.VM_OPERATIONS_": {
+        "dataType": "refAlias",
+        "type": { "dataType": "nestedObjectLiteral", "nestedProperties": {}, "additionalProperties": { "ref": "VM_OPERATIONS" }, "validators": {} },
+    },
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+    "VM_POWER_STATE": {
+        "dataType": "refAlias",
+        "type": { "dataType": "union", "subSchemas": [{ "dataType": "enum", "enums": ["Halted"] }, { "dataType": "enum", "enums": ["Paused"] }, { "dataType": "enum", "enums": ["Running"] }, { "dataType": "enum", "enums": ["Suspended"] }], "validators": {} },
+    },
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+    "DOMAIN_TYPE": {
+        "dataType": "refAlias",
+        "type": { "dataType": "union", "subSchemas": [{ "dataType": "enum", "enums": ["hvm"] }, { "dataType": "enum", "enums": ["pv"] }, { "dataType": "enum", "enums": ["pvh"] }, { "dataType": "enum", "enums": ["pv_in_pvh"] }, { "dataType": "enum", "enums": ["unspecified"] }], "validators": {} },
+    },
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+    "Unbrand_XoVm_": {
+        "dataType": "refAlias",
+        "type": { "dataType": "nestedObjectLiteral", "nestedProperties": { "$VBDs": { "dataType": "array", "array": { "dataType": "string" }, "required": true }, "$VGPUs": { "dataType": "array", "array": { "dataType": "string" }, "required": true }, "$container": { "dataType": "string", "required": true }, "$pool": { "dataType": "string", "required": true }, "$poolId": { "dataType": "string", "required": true }, "_xapiRef": { "dataType": "string", "required": true }, "CPUs": { "dataType": "nestedObjectLiteral", "nestedProperties": { "number": { "dataType": "double", "required": true }, "max": { "dataType": "double", "required": true } }, "required": true }, "PV_args": { "dataType": "string" }, "VGPUs": { "dataType": "array", "array": { "dataType": "string" }, "required": true }, "VIFs": { "dataType": "array", "array": { "dataType": "string" }, "required": true }, "VTPMs": { "dataType": "array", "array": { "dataType": "string" }, "required": true }, "addresses": { "ref": "Record_string.string_", "required": true }, "affinityHost": { "dataType": "string" }, "attachedPcis": { "dataType": "array", "array": { "dataType": "string" } }, "auto_poweron": { "dataType": "boolean", "required": true }, "bios_strings": { "ref": "Record_string.string_", "required": true }, "blockedOperations": { "ref": "Record_VM_OPERATIONS.string_", "required": true }, "boot": { "ref": "Record_string.string_", "required": true }, "coresPerSocket": { "dataType": "double" }, "cpuCap": { "dataType": "double" }, "cpuMask": { "dataType": "array", "array": { "dataType": "double" } }, "cpuWeight": { "dataType": "double" }, "creation": { "ref": "Record_string.string_", "required": true }, "current_operations": { "ref": "Record_string.VM_OPERATIONS_", "required": true }, "docker": { "dataType": "nestedObjectLiteral", "nestedProperties": { "version": { "dataType": "string" }, "process": { "dataType": "string" }, "info": { "dataType": "string" }, "enabled": { "dataType": "boolean", "required": true }, "containers": { "dataType": "array", "array": { "dataType": "string" } } } }, "expNestedHvm": { "dataType": "boolean", "required": true }, "hasVendorDevice": { "dataType": "boolean", "required": true }, "high_availability": { "dataType": "string", "required": true }, "installTime": { "dataType": "double" }, "isFirmwareSupported": { "dataType": "boolean", "required": true }, "memory": { "dataType": "nestedObjectLiteral", "nestedProperties": { "usage": { "dataType": "double" }, "static": { "dataType": "array", "array": { "dataType": "double" }, "required": true }, "size": { "dataType": "double", "required": true }, "dynamic": { "dataType": "array", "array": { "dataType": "double" }, "required": true } }, "required": true }, "mainIpAddress": { "dataType": "string" }, "managementAgentDetected": { "dataType": "boolean" }, "name_description": { "dataType": "string", "required": true }, "name_label": { "dataType": "string", "required": true }, "needsVtpm": { "dataType": "boolean", "required": true }, "nicType": { "dataType": "string" }, "notes": { "dataType": "string" }, "os_version": { "ref": "Record_string.string_", "required": true }, "other": { "ref": "Record_string.string_", "required": true }, "parent": { "dataType": "string" }, "power_state": { "ref": "VM_POWER_STATE", "required": true }, "pvDriversDetected": { "dataType": "boolean" }, "pvDriversUpToDate": { "dataType": "boolean" }, "pvDriversVersion": { "dataType": "string" }, "resourceSet": { "dataType": "string" }, "secureBoot": { "dataType": "boolean", "required": true }, "snapshots": { "dataType": "array", "array": { "dataType": "string" }, "required": true }, "startDelay": { "dataType": "double", "required": true }, "startTime": { "dataType": "double" }, "suspendSr": { "dataType": "string" }, "tags": { "dataType": "array", "array": { "dataType": "string" }, "required": true }, "vga": { "dataType": "string" }, "videoram": { "dataType": "double" }, "viridian": { "dataType": "boolean", "required": true }, "virtualizationMode": { "ref": "DOMAIN_TYPE", "required": true }, "xenStoreData": { "ref": "Record_string.string_", "required": true }, "xentools": { "dataType": "union", "subSchemas": [{ "dataType": "enum", "enums": [false] }, { "dataType": "nestedObjectLiteral", "nestedProperties": { "version": { "dataType": "string", "required": true }, "minor": { "dataType": "double", "required": true }, "major": { "dataType": "double", "required": true } } }] }, "id": { "dataType": "string", "required": true }, "type": { "dataType": "enum", "enums": ["VM"], "required": true } }, "validators": {} },
+    },
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+    "WithHref_Unbrand_XoVm__": {
+        "dataType": "refAlias",
+        "type": { "dataType": "intersection", "subSchemas": [{ "ref": "Unbrand_XoVm_" }, { "dataType": "nestedObjectLiteral", "nestedProperties": { "href": { "dataType": "string", "required": true } } }], "validators": {} },
+    },
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+    "Partial_Unbrand_XoVm__": {
+        "dataType": "refAlias",
+        "type": { "dataType": "nestedObjectLiteral", "nestedProperties": { "$VBDs": { "dataType": "array", "array": { "dataType": "string" } }, "$VGPUs": { "dataType": "array", "array": { "dataType": "string" } }, "$container": { "dataType": "string" }, "$pool": { "dataType": "string" }, "$poolId": { "dataType": "string" }, "_xapiRef": { "dataType": "string" }, "CPUs": { "dataType": "nestedObjectLiteral", "nestedProperties": { "number": { "dataType": "double", "required": true }, "max": { "dataType": "double", "required": true } } }, "PV_args": { "dataType": "string" }, "VGPUs": { "dataType": "array", "array": { "dataType": "string" } }, "VIFs": { "dataType": "array", "array": { "dataType": "string" } }, "VTPMs": { "dataType": "array", "array": { "dataType": "string" } }, "addresses": { "ref": "Record_string.string_" }, "affinityHost": { "dataType": "string" }, "attachedPcis": { "dataType": "array", "array": { "dataType": "string" } }, "auto_poweron": { "dataType": "boolean" }, "bios_strings": { "ref": "Record_string.string_" }, "blockedOperations": { "ref": "Record_VM_OPERATIONS.string_" }, "boot": { "ref": "Record_string.string_" }, "coresPerSocket": { "dataType": "double" }, "cpuCap": { "dataType": "double" }, "cpuMask": { "dataType": "array", "array": { "dataType": "double" } }, "cpuWeight": { "dataType": "double" }, "creation": { "ref": "Record_string.string_" }, "current_operations": { "ref": "Record_string.VM_OPERATIONS_" }, "docker": { "dataType": "nestedObjectLiteral", "nestedProperties": { "version": { "dataType": "string" }, "process": { "dataType": "string" }, "info": { "dataType": "string" }, "enabled": { "dataType": "boolean", "required": true }, "containers": { "dataType": "array", "array": { "dataType": "string" } } } }, "expNestedHvm": { "dataType": "boolean" }, "hasVendorDevice": { "dataType": "boolean" }, "high_availability": { "dataType": "string" }, "installTime": { "dataType": "double" }, "isFirmwareSupported": { "dataType": "boolean" }, "memory": { "dataType": "nestedObjectLiteral", "nestedProperties": { "usage": { "dataType": "double" }, "static": { "dataType": "array", "array": { "dataType": "double" }, "required": true }, "size": { "dataType": "double", "required": true }, "dynamic": { "dataType": "array", "array": { "dataType": "double" }, "required": true } } }, "mainIpAddress": { "dataType": "string" }, "managementAgentDetected": { "dataType": "boolean" }, "name_description": { "dataType": "string" }, "name_label": { "dataType": "string" }, "needsVtpm": { "dataType": "boolean" }, "nicType": { "dataType": "string" }, "notes": { "dataType": "string" }, "os_version": { "ref": "Record_string.string_" }, "other": { "ref": "Record_string.string_" }, "parent": { "dataType": "string" }, "power_state": { "ref": "VM_POWER_STATE" }, "pvDriversDetected": { "dataType": "boolean" }, "pvDriversUpToDate": { "dataType": "boolean" }, "pvDriversVersion": { "dataType": "string" }, "resourceSet": { "dataType": "string" }, "secureBoot": { "dataType": "boolean" }, "snapshots": { "dataType": "array", "array": { "dataType": "string" } }, "startDelay": { "dataType": "double" }, "startTime": { "dataType": "double" }, "suspendSr": { "dataType": "string" }, "tags": { "dataType": "array", "array": { "dataType": "string" } }, "vga": { "dataType": "string" }, "videoram": { "dataType": "double" }, "viridian": { "dataType": "boolean" }, "virtualizationMode": { "ref": "DOMAIN_TYPE" }, "xenStoreData": { "ref": "Record_string.string_" }, "xentools": { "dataType": "union", "subSchemas": [{ "dataType": "enum", "enums": [false] }, { "dataType": "nestedObjectLiteral", "nestedProperties": { "version": { "dataType": "string", "required": true }, "minor": { "dataType": "double", "required": true }, "major": { "dataType": "double", "required": true } } }] }, "id": { "dataType": "string" }, "type": { "dataType": "enum", "enums": ["VM"] } }, "validators": {} },
+    },
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+    "WithHref_Partial_Unbrand_XoVm___": {
+        "dataType": "refAlias",
+        "type": { "dataType": "intersection", "subSchemas": [{ "ref": "Partial_Unbrand_XoVm__" }, { "dataType": "nestedObjectLiteral", "nestedProperties": { "href": { "dataType": "string", "required": true } } }], "validators": {} },
+    },
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+};
+const templateService = new ExpressTemplateService(models, { "noImplicitAdditionalProperties": "throw-on-extras", "bodyCoercion": true });
+// WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+export function RegisterRoutes(app) {
+    // ###########################################################################################################
+    //  NOTE: If you do not see routes for all of your controllers in this file, then you might not have informed tsoa of where to look
+    //      Please look into the "controllerPathGlobs" config option described in the readme: https://github.com/lukeautry/tsoa
+    // ###########################################################################################################
+    const argsVmController_getVms = {
+        req: { "in": "request", "name": "req", "required": true, "dataType": "object" },
+        fields: { "in": "query", "name": "fields", "dataType": "string" },
+        filter: { "in": "query", "name": "filter", "dataType": "string" },
+        limit: { "in": "query", "name": "limit", "dataType": "double" },
+    };
+    app.get('/rest/v0/vms', authenticateMiddleware([{ "*": [] }]), ...(fetchMiddlewares(VmController)), ...(fetchMiddlewares(VmController.prototype.getVms)), async function VmController_getVms(request, response, next) {
+        // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+        let validatedArgs = [];
+        try {
+            validatedArgs = templateService.getValidatedArgs({ args: argsVmController_getVms, request, response });
+            const container = typeof iocContainer === 'function' ? iocContainer(request) : iocContainer;
+            const controller = await container.get(VmController);
+            if (typeof controller['setStatus'] === 'function') {
+                controller.setStatus(undefined);
+            }
+            await templateService.apiHandler({
+                methodName: 'getVms',
+                controller,
+                response,
+                next,
+                validatedArgs,
+                successStatus: undefined,
+            });
+        }
+        catch (err) {
+            return next(err);
+        }
+    });
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+    const argsVmController_getVm = {
+        id: { "in": "path", "name": "id", "required": true, "dataType": "string" },
+    };
+    app.get('/rest/v0/vms/:id', authenticateMiddleware([{ "*": [] }]), ...(fetchMiddlewares(VmController)), ...(fetchMiddlewares(VmController.prototype.getVm)), async function VmController_getVm(request, response, next) {
+        // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+        let validatedArgs = [];
+        try {
+            validatedArgs = templateService.getValidatedArgs({ args: argsVmController_getVm, request, response });
+            const container = typeof iocContainer === 'function' ? iocContainer(request) : iocContainer;
+            const controller = await container.get(VmController);
+            if (typeof controller['setStatus'] === 'function') {
+                controller.setStatus(undefined);
+            }
+            await templateService.apiHandler({
+                methodName: 'getVm',
+                controller,
+                response,
+                next,
+                validatedArgs,
+                successStatus: undefined,
+            });
+        }
+        catch (err) {
+            return next(err);
+        }
+    });
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+    function authenticateMiddleware(security = []) {
+        return async function runAuthenticationMiddleware(request, response, next) {
+            // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+            // keep track of failed auth attempts so we can hand back the most
+            // recent one.  This behavior was previously existing so preserving it
+            // here
+            const failedAttempts = [];
+            const pushAndRethrow = (error) => {
+                failedAttempts.push(error);
+                throw error;
+            };
+            const secMethodOrPromises = [];
+            for (const secMethod of security) {
+                if (Object.keys(secMethod).length > 1) {
+                    const secMethodAndPromises = [];
+                    for (const name in secMethod) {
+                        secMethodAndPromises.push(expressAuthenticationRecasted(request, name, secMethod[name], response)
+                            .catch(pushAndRethrow));
+                    }
+                    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+                    secMethodOrPromises.push(Promise.all(secMethodAndPromises)
+                        .then(users => { return users[0]; }));
+                }
+                else {
+                    for (const name in secMethod) {
+                        secMethodOrPromises.push(expressAuthenticationRecasted(request, name, secMethod[name], response)
+                            .catch(pushAndRethrow));
+                    }
+                }
+            }
+            // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+            try {
+                request['user'] = await Promise.any(secMethodOrPromises);
+                // Response was sent in middleware, abort
+                if (response.writableEnded) {
+                    return;
+                }
+                next();
+            }
+            catch (err) {
+                // Show most recent error as response
+                const error = failedAttempts.pop();
+                error.status = error.status || 401;
+                // Response was sent in middleware, abort
+                if (response.writableEnded) {
+                    return;
+                }
+                next(error);
+            }
+            // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+        };
+    }
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+}
+// WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa

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

@@ -0,0 +1,18 @@
+export class RestApi {
+    #xoApp;
+    constructor(xoApp) {
+        this.#xoApp = xoApp;
+    }
+    authenticateUser(...args) {
+        return this.#xoApp.authenticateUser(...args);
+    }
+    getObject(id, type) {
+        return this.#xoApp.getObject(id, type);
+    }
+    getObjectsByType(type, opts) {
+        return this.#xoApp.getObjectsByType(type, opts);
+    }
+    runWithApiContext(...args) {
+        return this.#xoApp.runWithApiContext(...args);
+    }
+}

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

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

package/dist/vms/vm.controller.mjs

@@ -0,0 +1,62 @@
+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 } from 'tsoa';
+import { inject } from 'inversify';
+import { provide } from 'inversify-binding-decorators';
+import { partialVms, vm, vmIds } from '../open-api/examples/vm.example.mjs';
+import { RestApi } from '../rest-api/rest-api.mjs';
+import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
+let VmController = class VmController extends XapiXoController {
+    constructor(restApi) {
+        super('VM', restApi);
+    }
+    /**
+     *
+     * @example fields "name_label,power_state,uuid"
+     * @example filter "power_state:Running"
+     * @example limit 42
+     */
+    getVms(req, fields, filter, limit) {
+        return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
+    }
+    /**
+     *
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     */
+    getVm(id) {
+        return this.getObject(id);
+    }
+};
+__decorate([
+    Example(vmIds),
+    Example(partialVms),
+    Get(''),
+    __param(0, Request()),
+    __param(1, Query()),
+    __param(2, Query()),
+    __param(3, Query())
+], VmController.prototype, "getVms", null);
+__decorate([
+    Example(vm),
+    Get('{id}'),
+    Response(404),
+    __param(0, Path())
+], VmController.prototype, "getVm", null);
+VmController = __decorate([
+    Route('vms'),
+    Security('*'),
+    Response(401)
+    // the `provide` decorator is mandatory on class that injects/receives dependencies.
+    // It automatically bind the class to the IOC container that handles dependency injection
+    ,
+    provide(VmController),
+    __param(0, inject(RestApi))
+], VmController);
+export { VmController };