@xen-orchestra/rest-api 0.4.0 → 0.5.0

package/dist/open-api/oa-examples/user.oa-example.mjs

@@ -0,0 +1,26 @@
+export const userIds = [
+    '/rest/v0/users/088124f3-41b6-4258-9653-6eedc7b46111',
+    '/rest/v0/users/a8715f02-20e7-4881-8b02-28ce2260c39d',
+];
+export const partialUsers = [
+    {
+        permission: 'none',
+        name: 'testName',
+        id: '088124f3-41b6-4258-9653-6eedc7b46111',
+        href: '/rest/v0/users/088124f3-41b6-4258-9653-6eedc7b46111',
+    },
+    {
+        permission: 'none',
+        id: 'a8715f02-20e7-4881-8b02-28ce2260c39d',
+        href: '/rest/v0/users/a8715f02-20e7-4881-8b02-28ce2260c39d',
+    },
+];
+export const user = {
+    email: 'admin@admin.net',
+    permission: 'admin',
+    pw_hash: '***obfuscated***',
+    groups: ['7d98fee4-3357-41a7-ac3f-9124212badb7', '7981ba62-c395-4546-bfa4-d1261653a77f'],
+    name: 'admin@admin.net',
+    preferences: {},
+    id: '722d17b9-699b-49d2-8193-be1ac573d3de',
+};

package/dist/open-api/oa-examples/vm-template.oa-example.mjs

@@ -69,7 +69,7 @@ export const vmTemplate = {
     $VGPUs: [],
     xenStoreData: {},
     vga: 'std',
-    videoram: '8',
+    videoram: 8,
     id: 'b7569d99-30f8-178a-7d94-801de3e29b5b-f873abe0-b138-4995-8f6f-498b423d234d',
     isDefaultTemplate: true,
     template_info: {

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

@@ -16,6 +16,8 @@ import { VdiSnapshotController } from './../../vdi-snapshots/vdi-snapshot.contro
 // 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 { VbdController } from './../../vbds/vbd.controller.mjs';
 // 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 { UserController } from './../../users/user.controller.mjs';
+// 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 { SrController } from './../../srs/sr.controller.mjs';
 // 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 { ServerController } from './../../servers/server.controller.mjs';
@@ -220,6 +222,21 @@ const models = {
         "type": { "dataType": "nestedObjectLiteral", "nestedProperties": { "$pool": { "dataType": "string", "required": true }, "$poolId": { "dataType": "string", "required": true }, "_xapiRef": { "dataType": "string", "required": true }, "uuid": { "dataType": "string", "required": true }, "attached": { "dataType": "boolean", "required": true }, "bootable": { "dataType": "boolean", "required": true }, "device": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "enum", "enums": [null] }], "required": true }, "id": { "dataType": "string", "required": true }, "is_cd_drive": { "dataType": "boolean", "required": true }, "position": { "dataType": "string", "required": true }, "read_only": { "dataType": "boolean", "required": true }, "type": { "dataType": "enum", "enums": ["VBD"], "required": true }, "VDI": { "dataType": "string", "required": true }, "VM": { "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_XoUser__": {
+        "dataType": "refAlias",
+        "type": { "dataType": "nestedObjectLiteral", "nestedProperties": { "authProviders": { "dataType": "union", "subSchemas": [{ "ref": "Record_string.string_" }, { "dataType": "undefined" }] }, "email": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "groups": { "dataType": "union", "subSchemas": [{ "dataType": "array", "array": { "dataType": "string" } }, { "dataType": "undefined" }] }, "id": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "name": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "permission": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "pw_hash": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "preferences": { "dataType": "union", "subSchemas": [{ "ref": "Record_string.string_" }, { "dataType": "undefined" }] } }, "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_XoUser___": {
+        "dataType": "refAlias",
+        "type": { "dataType": "intersection", "subSchemas": [{ "ref": "Partial_Unbrand_XoUser__" }, { "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
+    "Unbrand_XoUser_": {
+        "dataType": "refAlias",
+        "type": { "dataType": "nestedObjectLiteral", "nestedProperties": { "authProviders": { "dataType": "union", "subSchemas": [{ "ref": "Record_string.string_" }, { "dataType": "undefined" }] }, "email": { "dataType": "string", "required": true }, "groups": { "dataType": "array", "array": { "dataType": "string" }, "required": true }, "id": { "dataType": "string", "required": true }, "name": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "permission": { "dataType": "string", "required": true }, "pw_hash": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "preferences": { "ref": "Record_string.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
     "Record_string.STORAGE_OPERATIONS_": {
         "dataType": "refAlias",
         "type": { "dataType": "nestedObjectLiteral", "nestedProperties": {}, "validators": {} },
@@ -900,6 +917,63 @@ export function RegisterRoutes(app) {
         }
     });
     // 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 argsUserController_getUsers = {
+        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/users', authenticateMiddleware([{ "*": [] }]), ...(fetchMiddlewares(UserController)), ...(fetchMiddlewares(UserController.prototype.getUsers)), async function UserController_getUsers(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: argsUserController_getUsers, request, response });
+            const container = typeof iocContainer === 'function' ? iocContainer(request) : iocContainer;
+            const controller = await container.get(UserController);
+            if (typeof controller['setStatus'] === 'function') {
+                controller.setStatus(undefined);
+            }
+            await templateService.apiHandler({
+                methodName: 'getUsers',
+                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 argsUserController_getUser = {
+        id: { "in": "path", "name": "id", "required": true, "dataType": "string" },
+    };
+    app.get('/rest/v0/users/:id', authenticateMiddleware([{ "*": [] }]), ...(fetchMiddlewares(UserController)), ...(fetchMiddlewares(UserController.prototype.getUser)), async function UserController_getUser(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: argsUserController_getUser, request, response });
+            const container = typeof iocContainer === 'function' ? iocContainer(request) : iocContainer;
+            const controller = await container.get(UserController);
+            if (typeof controller['setStatus'] === 'function') {
+                controller.setStatus(undefined);
+            }
+            await templateService.apiHandler({
+                methodName: 'getUser',
+                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 argsSrController_getSrs = {
         req: { "in": "request", "name": "req", "required": true, "dataType": "object" },
         fields: { "in": "query", "name": "fields", "dataType": "string" },

package/dist/users/user.controller.mjs

@@ -0,0 +1,70 @@
+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 { partialUsers, user, userIds } from '../open-api/oa-examples/user.oa-example.mjs';
+import { XoController } from '../abstract-classes/xo-controller.mjs';
+let UserController = class UserController extends XoController {
+    // --- abstract methods
+    async getAllCollectionObjects() {
+        const users = await this.restApi.xoApp.getAllUsers();
+        return users.map(user => this.#sanitizeUser(user));
+    }
+    async getCollectionObject(id) {
+        const user = await this.restApi.xoApp.getUser(id);
+        return this.#sanitizeUser(user);
+    }
+    #sanitizeUser(user) {
+        const sanitizedUser = { ...user };
+        if (sanitizedUser.pw_hash !== undefined) {
+            sanitizedUser.pw_hash = '***obfuscated***';
+        }
+        return sanitizedUser;
+    }
+    /**
+     * @example fields "permission,name,id"
+     * @example filter "permission:none"
+     * @example limit 42
+     */
+    async getUsers(req, fields, filter, limit) {
+        const users = Object.values(await this.getObjects({ filter, limit }));
+        return this.sendObjects(users, req);
+    }
+    /**
+     * @example id "722d17b9-699b-49d2-8193-be1ac573d3de"
+     */
+    getUser(id) {
+        return this.getObject(id);
+    }
+};
+__decorate([
+    Example(userIds),
+    Example(partialUsers),
+    Get(''),
+    __param(0, Request()),
+    __param(1, Query()),
+    __param(2, Query()),
+    __param(3, Query())
+], UserController.prototype, "getUsers", null);
+__decorate([
+    Example(user),
+    Get('{id}'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path())
+], UserController.prototype, "getUser", null);
+UserController = __decorate([
+    Route('users'),
+    Security('*'),
+    Response(unauthorizedResp.status, unauthorizedResp.description),
+    Tags('users'),
+    provide(UserController)
+], UserController);
+export { UserController };

package/open-api/spec/swagger.json

@@ -3978,6 +3978,96 @@
 				],
 				"type": "object"
 			},
+			"Partial_Unbrand_XoUser__": {
+				"properties": {
+					"authProviders": {
+						"$ref": "#/components/schemas/Record_string.string_"
+					},
+					"email": {
+						"type": "string"
+					},
+					"groups": {
+						"items": {
+							"type": "string"
+						},
+						"type": "array"
+					},
+					"id": {
+						"type": "string"
+					},
+					"name": {
+						"type": "string"
+					},
+					"permission": {
+						"type": "string"
+					},
+					"pw_hash": {
+						"type": "string"
+					},
+					"preferences": {
+						"$ref": "#/components/schemas/Record_string.string_"
+					}
+				},
+				"type": "object",
+				"description": "Make all properties in T optional"
+			},
+			"WithHref_Partial_Unbrand_XoUser___": {
+				"allOf": [
+					{
+						"$ref": "#/components/schemas/Partial_Unbrand_XoUser__"
+					},
+					{
+						"properties": {
+							"href": {
+								"type": "string"
+							}
+						},
+						"required": [
+							"href"
+						],
+						"type": "object"
+					}
+				]
+			},
+			"Unbrand_XoUser_": {
+				"properties": {
+					"authProviders": {
+						"$ref": "#/components/schemas/Record_string.string_"
+					},
+					"email": {
+						"type": "string"
+					},
+					"groups": {
+						"items": {
+							"type": "string"
+						},
+						"type": "array"
+					},
+					"id": {
+						"type": "string"
+					},
+					"name": {
+						"type": "string"
+					},
+					"permission": {
+						"type": "string"
+					},
+					"pw_hash": {
+						"type": "string"
+					},
+					"preferences": {
+						"$ref": "#/components/schemas/Record_string.string_"
+					}
+				},
+				"required": [
+					"email",
+					"groups",
+					"id",
+					"permission",
+					"preferences"
+				],
+				"type": "object"
+			},
 			"Record_string.STORAGE_OPERATIONS_": {
 				"properties": {},
 				"type": "object",
@@ -5870,7 +5960,7 @@
 	},
 	"info": {
 		"title": "@xen-orchestra/rest-api",
-		"version": "0.4.0",
+		"version": "0.5.0",
 		"description": "REST API to manage your XOA",
 		"license": {
 			"name": "AGPL-3.0-or-later"
@@ -7636,7 +7726,7 @@
 											"$VGPUs": [],
 											"xenStoreData": {},
 											"vga": "std",
-											"videoram": "8",
+											"videoram": 8,
 											"id": "b7569d99-30f8-178a-7d94-801de3e29b5b-f873abe0-b138-4995-8f6f-498b423d234d",
 											"isDefaultTemplate": true,
 											"template_info": {
@@ -8916,6 +9006,158 @@
 				]
 			}
 		},
+		"/users": {
+			"get": {
+				"operationId": "GetUsers",
+				"responses": {
+					"200": {
+						"description": "Ok",
+						"content": {
+							"application/json": {
+								"schema": {
+									"anyOf": [
+										{
+											"items": {
+												"type": "string"
+											},
+											"type": "array"
+										},
+										{
+											"items": {
+												"$ref": "#/components/schemas/WithHref_Partial_Unbrand_XoUser___"
+											},
+											"type": "array"
+										}
+									]
+								},
+								"examples": {
+									"Example 1": {
+										"value": [
+											"/rest/v0/users/088124f3-41b6-4258-9653-6eedc7b46111",
+											"/rest/v0/users/a8715f02-20e7-4881-8b02-28ce2260c39d"
+										]
+									},
+									"Example 2": {
+										"value": [
+											{
+												"permission": "none",
+												"name": "testName",
+												"id": "088124f3-41b6-4258-9653-6eedc7b46111",
+												"href": "/rest/v0/users/088124f3-41b6-4258-9653-6eedc7b46111"
+											},
+											{
+												"permission": "none",
+												"id": "a8715f02-20e7-4881-8b02-28ce2260c39d",
+												"href": "/rest/v0/users/a8715f02-20e7-4881-8b02-28ce2260c39d"
+											}
+										]
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "Authentication required"
+					}
+				},
+				"tags": [
+					"users"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "query",
+						"name": "fields",
+						"required": false,
+						"schema": {
+							"type": "string"
+						},
+						"example": "permission,name,id"
+					},
+					{
+						"in": "query",
+						"name": "filter",
+						"required": false,
+						"schema": {
+							"type": "string"
+						},
+						"example": "permission:none"
+					},
+					{
+						"in": "query",
+						"name": "limit",
+						"required": false,
+						"schema": {
+							"format": "double",
+							"type": "number"
+						},
+						"example": 42
+					}
+				]
+			}
+		},
+		"/users/{id}": {
+			"get": {
+				"operationId": "GetUser",
+				"responses": {
+					"200": {
+						"description": "Ok",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Unbrand_XoUser_"
+								},
+								"examples": {
+									"Example 1": {
+										"value": {
+											"email": "admin@admin.net",
+											"permission": "admin",
+											"pw_hash": "***obfuscated***",
+											"groups": [
+												"7d98fee4-3357-41a7-ac3f-9124212badb7",
+												"7981ba62-c395-4546-bfa4-d1261653a77f"
+											],
+											"name": "admin@admin.net",
+											"preferences": {},
+											"id": "722d17b9-699b-49d2-8193-be1ac573d3de"
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					}
+				},
+				"tags": [
+					"users"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"example": "722d17b9-699b-49d2-8193-be1ac573d3de"
+					}
+				]
+			}
+		},
 		"/srs": {
 			"get": {
 				"operationId": "GetSrs",

package/package.json

@@ -6,7 +6,7 @@
   "main": "./dist/index.mjs",
   "name": "@xen-orchestra/rest-api",
   "homepage": "https://github.com/vatesfr/xen-orchestra/tree/master/@xen-orchestra/rest-api",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "REST API to manage your XOA",
   "license": "AGPL-3.0-or-later",
   "private": false,