backend/source/types.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.type
{
	
	/**
	 */
	export type group_id = int;
	
	
	/**
	 */
	export type group_object = {
		name : string;
	};
	
	
	/**
	 */
	export type admin_id = int;
	
	
	/**
	 */
	export type admin_object = {
		name : string;
		email_address : (null | string);
		password_image : string;
		password_fail_count : int;
	};
	
	
	/**
	 */
	export type member_id = int;
	
	
	/**
	 */
	export type member_object = {
		name : string;
		email_address : (null | string);
		groups : Array<group_id>;
		enabled : boolean;
		password_image : (null | string);
		password_change_last_attempt : (null | int);
		password_change_token : (null | string);
	};
	
	
	/**
	 */
	export type invitation_id = int;
	
	
	/**
	 */
	export type invitation_key = string;
	
	
	/**
	 * @todo use "pod" instead of "changable"/"value"
	 */
	export type invitation_object = {
		key : invitation_key;
		expiry : (null | int);
		name_changeable : boolean;
		name_value : (null | string);
		email_address_changeable : boolean;
		email_address_value : (null | string);
		groups_changeable : boolean;
		groups_value : (null | Array<_espe.type.group_id>);
	};
	
}