backend/source/api/actions/member_read.ts

/*
Espe | Ein schlichtes Werkzeug zur Mitglieder-Verwaltung | Backend
Copyright (C) 2024 Christian Fraß

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public 
License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later 
version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied 
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see 
<https://www.gnu.org/licenses/>. 
 */

namespace _espe.api
{
	
	/**
	 */
	export function register_member_read(
		rest_subject : lib_plankton.rest_http.type_rest
	) : void
	{
		lib_plankton.rest_http.register<
			null,
			{
				name : string;
				email_address : (null | string);
				groups : Array<int>;
				enabled : boolean;
				password_set : boolean;
			}
		>(
			rest_subject,
			lib_plankton.http.enum_method.get,
			_espe.api.full_path("/member/read/:id"),
			{
				"description": () => "gibt ein Mitglied anhand seiner ID aus",
				"output_schema": () => ({
					"nullable": false,
					"type": "object",
					"properties": {
						"name": {
							"nullable": false,
							"type": "string"
						},
						"email_address": {
							"nullable": true,
							"type": "string"
						},
						"groups": {
							"nullable": false,
							"type": "array",
							"items": {
								"nullable": false,
								"type": "int"
							}
						},
						"enabled": {
							"nullable": false,
							"type": "boolean"
						},
					},
					"additionalProperties": false,
					"required": [
						"name",
						"email_address",
						"groups",
						"enabled",
						"password_set",
					]
				}),
				"restriction": () => restriction_logged_in,
				"execution": () => async ({"path_parameters": path_parameters, "input": input}) => {
					const member_id : _espe.type.member_id = parseInt(path_parameters["id"]);
					const member_object : _espe.type.member_object = await _espe.service.member.get(member_id);
					return Promise.resolve({
						"status_code": 200,
						"data": {
							"name": member_object.name,
							"email_address": member_object.email_address,
							"groups": member_object.groups,
							"enabled": member_object.enabled,
							"password_set": (member_object.password_image !== null),
						},
					});
				}
			}
		);
	}
	
}