From d4fdebceca6b287897f61eeba6d46ac69540c9cc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20Fra=C3=9F?= Date: Sat, 12 Apr 2025 10:20:58 +0000 Subject: [PATCH] [task-193] [int] --- misc/sampledata.json | 8 +-- source/api/actions/invite_create.ts | 44 +++++++------- source/api/actions/invite_examine.ts | 38 ++++++------ source/api/actions/invite_list.ts | 86 ++++++++++++++++++++++++++++ source/api/functions.ts | 1 + source/helpers.ts | 50 +++++++--------- source/repositories/invite.ts | 16 +++--- source/repositories/member.ts | 24 ++++---- source/sample.ts | 16 +++--- source/services/invite.ts | 64 +++++++++++++++------ source/types.ts | 29 ++-------- tools/makefile | 1 + 12 files changed, 233 insertions(+), 144 deletions(-) create mode 100644 source/api/actions/invite_list.ts diff --git a/misc/sampledata.json b/misc/sampledata.json index 43a66b6..a591264 100644 --- a/misc/sampledata.json +++ b/misc/sampledata.json @@ -28,13 +28,13 @@ ], "invites": [ { - "membership_number_mode": 1, + "membership_number_changeable": false, "membership_number_value": "456", - "name_mode": 1, + "name_changeable": true, "name_value": "Daniel Distel", - "email_address_mode": 1, + "email_address_changeable": true, "email_address_value": "duesentrieb@example.org", - "groups_mode": 1, + "groups_changeable": false, "groups_value": ["flugzeug","zu_fuß"] } ] diff --git a/source/api/actions/invite_create.ts b/source/api/actions/invite_create.ts index a3870b6..f43f953 100644 --- a/source/api/actions/invite_create.ts +++ b/source/api/actions/invite_create.ts @@ -24,13 +24,13 @@ namespace _espe.api { lib_plankton.rest_http.register< { - membership_number_mode : int; + membership_number_changeable : boolean; membership_number_value : (null | string); - name_mode : int; + name_changeable : boolean; name_value : string; - email_address_mode : int; + email_address_changeable : boolean; email_address_value : (null | string); - groups_mode : int; + groups_changeable : boolean; groups_value : Array; expiry ?: (null | int); // notification_target_url_template ?: (null | string); @@ -57,30 +57,30 @@ namespace _espe.api "nullable": false, "additionalProperties": false, "properties": { - "membership_number_mode": { - "type": "integer", + "membership_number_changeable": { + "type": "boolean", "nullable": false, - "description": "Mitgliedsnummer | Modus" + "description": "Mitgliedsnummer | änderbar" }, "membership_number_value": { "type": "string", "nullable": true, "description": "Mitgliedsnummer | Wert" }, - "name_mode": { - "type": "integer", + "name_changeable": { + "type": "boolean", "nullable": false, - "description": "Name | Modus" + "description": "Name | änderbar" }, "name_value": { "type": "string", "nullable": true, "description": "Name | Wert" }, - "email_address_mode": { - "type": "integer", - "nullable": true, - "description": "E-Mail-Adresse | Modus" + "email_address_changeable": { + "type": "boolean", + "nullable": false, + "description": "E-Mail-Adresse | änderbar" }, "email_address_value": { "type": "string", @@ -115,13 +115,13 @@ namespace _espe.api */ }, "required": [ - "membership_number_mode", + "membership_number_changeable", "membership_number_value", - "name_mode", + "name_changeable", "name_value", - "email_address_mode", + "email_address_changeable", "email_address_value", - "groups_mode", + "groups_changeable", "groups_value", "expiry", ] @@ -168,13 +168,13 @@ namespace _espe.api else { const invite_info : {id : _espe.type.invite_id; key : _espe.type.invite_key;} = await _espe.service.invite.create( { - "membership_number_mode": _espe.helpers.invite_prefill_mode_decode(input.membership_number_mode), + "membership_number_changeable": input.membership_number_changeable, "membership_number_value": input.membership_number_value, - "name_mode": _espe.helpers.invite_prefill_mode_decode(input.name_mode), + "name_changeable": input.name_changeable, "name_value": input.name_value, - "email_address_mode": _espe.helpers.invite_prefill_mode_decode(input.email_address_mode), + "email_address_changeable": input.email_address_changeable, "email_address_value": input.email_address_value, - "groups_mode": _espe.helpers.invite_prefill_mode_decode(input.groups_mode), + "groups_changeable": input.groups_changeable, "groups_value": input.groups_value, }, { diff --git a/source/api/actions/invite_examine.ts b/source/api/actions/invite_examine.ts index dec17ee..163d4a0 100644 --- a/source/api/actions/invite_examine.ts +++ b/source/api/actions/invite_examine.ts @@ -47,43 +47,43 @@ namespace _espe.api "properties": { "expiry": { "nullable": true, - "type": "intiger", + "type": "integer", "description": "Ablaufzeitpunkt" }, - "membership_number_mode": { - "type": "integer", + "membership_number_changeable": { + "type": "boolean", "nullable": false, - "description": "Mitgliedsnummer | Modus" + "description": "Mitgliedsnummer | änderbar" }, "membership_number_value": { "type": "string", "nullable": true, "description": "Mitgliedsnummer | Wert" }, - "name_mode": { - "type": "integer", + "name_changeable": { + "type": "boolean", "nullable": false, - "description": "Name | Modus" + "description": "Name | änderbar" }, "name_value": { "type": "string", "nullable": true, "description": "Name | Wert" }, - "email_address_mode": { - "type": "integer", - "nullable": true, - "description": "E-Mail-Adresse | Modus" + "email_address_changeable": { + "type": "boolean", + "nullable": false, + "description": "E-Mail-Adresse | änderbar" }, "email_address_value": { "type": "string", "nullable": true, "description": "E-Mail-Adresse | Wert" }, - "groups_mode": { - "type": "integer", - "nullable": true, - "description": "Gruppen | Modus" + "groups_changeable": { + "type": "boolean", + "nullable": false, + "description": "Gruppen | änderbar" }, "groups_value": { "nullable": false, @@ -117,13 +117,13 @@ namespace _espe.api "status_code": 200, "data": { "expiry": invite_object.expiry, - "membership_number_mode": _espe.helpers.invite_prefill_mode_encode(invite_object.membership_number_mode), + "membership_number_changeable": invite_object.membership_number_changeable, "membership_number_value": invite_object.membership_number_value, - "name_mode": _espe.helpers.invite_prefill_mode_encode(invite_object.name_mode), + "name_changeable": invite_object.name_changeable, "name_value": invite_object.name_value, - "email_address_mode": _espe.helpers.invite_prefill_mode_encode(invite_object.email_address_mode), + "email_address_changeable": invite_object.email_address_changeable, "email_address_value": invite_object.email_address_value, - "groups_mode": _espe.helpers.invite_prefill_mode_encode(invite_object.groups_mode), + "groups_changeable": invite_object.groups_changeable, "groups_value": invite_object.groups_value, } }) diff --git a/source/api/actions/invite_list.ts b/source/api/actions/invite_list.ts new file mode 100644 index 0000000..e0bdfdf --- /dev/null +++ b/source/api/actions/invite_list.ts @@ -0,0 +1,86 @@ +/* +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 +. + */ + +namespace _espe.api +{ + /** + */ + export function register_invite_list( + rest_subject : lib_plankton.rest_http.type_rest + ) : void + { + lib_plankton.rest_http.register< + null, + Array< + { + id : _espe.type.invite_id; + key : _espe.type.invite_key; + expiry : (null | int); + name_value : string; + } + > + >( + rest_subject, + lib_plankton.http.enum_method.get, + _espe.api.full_path("/invite/list"), + { + /** + * @todo translation + */ + "description": () => "listet alle Einladung auf", + "output_schema": () => ({ + "type": "object", + "nullable": false, + "additionalProperties": false, + "properties": { + "id": { + "nullable": false, + "type": "intiger", + "description": "ID" + }, + "key": { + "nullable": false, + "type": "string", + "description": "Schlüssel" + }, + "expiry": { + "nullable": true, + "type": "integer", + "description": "Ablauf" + }, + "name_value": { + "nullable": false, + "type": "string", + "description": "Name" + }, + }, + "required": [ + "id", + "key", + ] + }), + "restriction": () => restriction_logged_in, + "execution": () => async ({}) => { + const data = await _espe.service.invite.list(); + return Promise.resolve({ + "status_code": 200, + "data": data + }); + } + } + ); + } + +} diff --git a/source/api/functions.ts b/source/api/functions.ts index e2d8fd5..04dd3a1 100644 --- a/source/api/functions.ts +++ b/source/api/functions.ts @@ -61,6 +61,7 @@ namespace _espe.api } // invite { + _espe.api.register_invite_list(rest_subject); _espe.api.register_invite_create(rest_subject); _espe.api.register_invite_examine(rest_subject); _espe.api.register_invite_accept(rest_subject); diff --git a/source/helpers.ts b/source/helpers.ts index 4adf64b..bb68605 100644 --- a/source/helpers.ts +++ b/source/helpers.ts @@ -16,6 +16,26 @@ You should have received a copy of the GNU General Public License along with thi namespace _espe.helpers { + /** + */ + export function dbbool_encode( + value : boolean + ) : int + { + return (value ? 0 : 1); + } + + + /** + */ + export function dbbool_decode( + value : int + ) : boolean + { + return (value > 0); + } + + /** */ export type type_smtp_credentials = { @@ -248,34 +268,4 @@ namespace _espe.helpers } } - - /** - */ - export function invite_prefill_mode_encode( - invite_prefill_mode : _espe.type.invite_prefill_mode - ) : _espe.type.invite_prefill_mode_raw - { - switch (invite_prefill_mode) { - case _espe.type.invite_prefill_mode.hidden: return 0; - case _espe.type.invite_prefill_mode.locked: return 1; - case _espe.type.invite_prefill_mode.free: return 2; - default: throw (new Error("unhandled invite prefill mode: " + String(invite_prefill_mode))); - } - } - - - /** - */ - export function invite_prefill_mode_decode( - invite_prefill_mode_encoded : _espe.type.invite_prefill_mode_raw - ) : _espe.type.invite_prefill_mode - { - switch (invite_prefill_mode_encoded) { - case 0: return _espe.type.invite_prefill_mode.hidden; - case 1: return _espe.type.invite_prefill_mode.locked; - case 2: return _espe.type.invite_prefill_mode.free; - default: throw (new Error("unhandled encoded invite prefill mode: " + String(invite_prefill_mode_encoded))); - } - } - } diff --git a/source/repositories/invite.ts b/source/repositories/invite.ts index 3a6e8f9..8de1cb0 100644 --- a/source/repositories/invite.ts +++ b/source/repositories/invite.ts @@ -119,13 +119,13 @@ namespace _espe.repository.invite "core_row": { "key": object.key, "expiry": object.expiry, - "membership_number_mode": _espe.helpers.invite_prefill_mode_encode(object.membership_number_mode), + "membership_number_changeable": _espe.helpers.dbbool_encode(object.membership_number_changeable), "membership_number_value": object.membership_number_value, - "name_mode": _espe.helpers.invite_prefill_mode_encode(object.name_mode), + "name_changeable": _espe.helpers.dbbool_encode(object.name_changeable), "name_value": object.name_value, - "email_address_mode": _espe.helpers.invite_prefill_mode_encode(object.email_address_mode), + "email_address_changeable": _espe.helpers.dbbool_encode(object.email_address_changeable), "email_address_value": object.email_address_value, - "groups_mode": _espe.helpers.invite_prefill_mode_encode(object.groups_mode), + "groups_changeable": _espe.helpers.dbbool_encode(object.groups_changeable), }, "group_rows": ( object.groups_value @@ -148,13 +148,13 @@ namespace _espe.repository.invite return { "key": dispersal.core_row["key"], "expiry": dispersal.core_row["expiry"], - "membership_number_mode": _espe.helpers.invite_prefill_mode_decode(dispersal.core_row["membership_number_mode"]), + "membership_number_changeable": _espe.helpers.dbbool_decode(dispersal.core_row["membership_number_changeable"]), "membership_number_value": dispersal.core_row["membership_number_value"], - "name_mode": _espe.helpers.invite_prefill_mode_decode(dispersal.core_row["name_mode"]), + "name_changeable": _espe.helpers.dbbool_decode(dispersal.core_row["name_changeable"]), "name_value": dispersal.core_row["name_value"], - "email_address_mode": _espe.helpers.invite_prefill_mode_decode(dispersal.core_row["email_address_mode"]), + "email_address_changeable": _espe.helpers.dbbool_decode(dispersal.core_row["email_address_changeable"]), "email_address_value": dispersal.core_row["email_address_value"], - "groups_mode": _espe.helpers.invite_prefill_mode_decode(dispersal.core_row["groups_mode"]), + "groups_changeable": _espe.helpers.dbbool_decode(dispersal.core_row["groups_changeable"]), "groups_value": lib_plankton.list.sorted( dispersal.group_rows.map(row => row["group_name"]), { diff --git a/source/repositories/member.ts b/source/repositories/member.ts index e9e7398..cf624d4 100644 --- a/source/repositories/member.ts +++ b/source/repositories/member.ts @@ -121,12 +121,12 @@ namespace _espe.repository.member "name_real_value": object.name_real_value, "name_real_index": object.name_real_index, "email_address_private": object.email_address_private, - "registered": (object.registered ? 1 : 0), - "enabled": (object.enabled ? 1 : 0), - "email_use_veiled_address": (object.email_use_veiled_address ? 1 : 0), - "email_use_nominal_address": (object.email_use_nominal_address ? 1 : 0), - "email_redirect_to_private_address": (object.email_redirect_to_private_address ? 1 : 0), - "email_allow_sending": (object.email_allow_sending ? 1 : 0), + "registered": _espe.helpers.dbbool_encode(object.registered), + "enabled": _espe.helpers.dbbool_encode(object.enabled), + "email_use_veiled_address": _espe.helpers.dbbool_encode(object.email_use_veiled_address), + "email_use_nominal_address": _espe.helpers.dbbool_encode(object.email_use_nominal_address), + "email_redirect_to_private_address": _espe.helpers.dbbool_encode(object.email_redirect_to_private_address), + "email_allow_sending": _espe.helpers.dbbool_encode(object.email_allow_sending), "password_image": object.password_image, "password_change_last_attempt": object.password_change_last_attempt, "password_change_token": object.password_change_token, @@ -160,12 +160,12 @@ namespace _espe.repository.member "compare_element": (group1, group2) => (group1 <= group2) } ), - "registered": (dispersal.core_row["registered"] > 0), - "enabled": (dispersal.core_row["enabled"] > 0), - "email_use_veiled_address": (dispersal.core_row["email_use_veiled_address"] > 0), - "email_use_nominal_address": (dispersal.core_row["email_use_nominal_address"] > 0), - "email_redirect_to_private_address": (dispersal.core_row["email_redirect_to_private_address"] > 0), - "email_allow_sending": (dispersal.core_row["email_allow_sending"] > 0), + "registered": _espe.helpers.dbbool_decode(dispersal.core_row["registered"]), + "enabled": _espe.helpers.dbbool_decode(dispersal.core_row["enabled"]), + "email_use_veiled_address": _espe.helpers.dbbool_decode(dispersal.core_row["email_use_veiled_address"]), + "email_use_nominal_address": _espe.helpers.dbbool_decode(dispersal.core_row["email_use_nominal_address"]), + "email_redirect_to_private_address": _espe.helpers.dbbool_decode(dispersal.core_row["email_redirect_to_private_address"]), + "email_allow_sending": _espe.helpers.dbbool_decode(dispersal.core_row["email_allow_sending"]), "password_image": dispersal.core_row["password_image"], "password_change_last_attempt": dispersal.core_row["password_change_last_attempt"], "password_change_token": dispersal.core_row["password_change_token"], diff --git a/source/sample.ts b/source/sample.ts index 0d4f0d8..d435d6b 100644 --- a/source/sample.ts +++ b/source/sample.ts @@ -36,13 +36,13 @@ namespace _espe.sample >; invites : Array< { - membership_number_mode : _espe.type.invite_prefill_mode_raw; + membership_number_changeable : boolean; membership_number_value : string; - name_mode : _espe.type.invite_prefill_mode_raw; + name_changeable : boolean; name_value : string; - email_address_mode : _espe.type.invite_prefill_mode_raw; + email_address_changeable : boolean; email_address_value : (null | string); - groups_mode : _espe.type.invite_prefill_mode_raw; + groups_changeable : boolean; groups_value : Array; } >; @@ -89,13 +89,13 @@ namespace _espe.sample for (const invite_raw of data.invites) { const result : {id : _espe.type.invite_id; key : _espe.type.invite_key;} = await _espe.service.invite.create( { - "membership_number_mode": _espe.helpers.invite_prefill_mode_decode(invite_raw.membership_number_mode), + "membership_number_changeable": invite_raw.membership_number_changeable, "membership_number_value": invite_raw.membership_number_value, - "name_mode": invite_raw.name_mode, + "name_changeable": invite_raw.name_changeable, "name_value": invite_raw.name_value, - "email_address_mode": invite_raw.email_address_mode, + "email_address_changeable": invite_raw.email_address_changeable, "email_address_value": invite_raw.email_address_value, - "groups_mode": invite_raw.groups_mode, + "groups_changeable": invite_raw.groups_changeable, "groups_value": invite_raw.groups_value, } ); diff --git a/source/services/invite.ts b/source/services/invite.ts index 0ceb332..7629633 100644 --- a/source/services/invite.ts +++ b/source/services/invite.ts @@ -16,26 +16,58 @@ You should have received a copy of the GNU General Public License along with thi namespace _espe.service.invite { + /** + */ + export function list( + ) : Promise< + Array< + { + id : _espe.type.invite_id; + key : _espe.type.invite_key; + expiry : (null | int); + name_value : string; + } + > + > + { + return ( + _espe.repository.invite.dump() + .then( + entries => Promise.resolve( + entries.map( + entry => ({ + "id": entry.id, + "key": entry.object.key, + "expiry": entry.object.expiry, + "name_value": entry.object.name_value + }) + ) + ) + ) + ); + } + + /** */ export async function create( { - "membership_number_mode": membership_number_mode, + "membership_number_changeable": membership_number_changeable, "membership_number_value": membership_number_value, - "name_mode": name_mode, + "name_changeable": name_changeable, "name_value": name_value, - "email_address_mode": email_address_mode, + "email_address_changeable": email_address_changeable, "email_address_value": email_address_value, - "groups_mode": groups_mode, + "groups_changeable": groups_changeable, "groups_value": groups_value, } : { - membership_number_mode : _espe.type.invite_prefill_mode; + membership_number_changeable : boolean; membership_number_value : (null | string); - name_mode : _espe.type.invite_prefill_mode; + name_changeable : boolean; name_value : string; - email_address_mode : _espe.type.invite_prefill_mode; + email_address_changeable : boolean; email_address_value : (null | string); - groups_mode : _espe.type.invite_prefill_mode; + groups_changeable : boolean; groups_value : Array; }, { @@ -72,13 +104,13 @@ namespace _espe.service.invite : expiry ), - "membership_number_mode": membership_number_mode, + "membership_number_changeable": membership_number_changeable, "membership_number_value": membership_number_value, - "name_mode": name_mode, + "name_changeable": name_changeable, "name_value": name_value, - "email_address_mode": email_address_mode, + "email_address_changeable": email_address_changeable, "email_address_value": email_address_value, - "groups_mode": groups_mode, + "groups_changeable": groups_changeable, "groups_value": groups_value, }; const invite_id : _espe.type.invite_id = await _espe.repository.invite.create(invite_object); @@ -154,7 +186,7 @@ namespace _espe.service.invite const member_id : _espe.type.member_id = await _espe.service.member.project( { "membership_number": ( - (invite_object.membership_number_mode === _espe.type.invite_prefill_mode.free) + invite_object.membership_number_changeable ? membership_number_value : @@ -162,7 +194,7 @@ namespace _espe.service.invite ), "name_real_value": ( ( - (invite_object.name_mode === _espe.type.invite_prefill_mode.free) + invite_object.name_changeable && (name_value !== null) ) @@ -173,7 +205,7 @@ namespace _espe.service.invite ), "email_address_private": ( ( - (invite_object.email_address_mode === _espe.type.invite_prefill_mode.free) + invite_object.email_address_changeable && (email_address_value !== null) ) @@ -183,7 +215,7 @@ namespace _espe.service.invite invite_object.email_address_value ), "groups": ( - (invite_object.groups_mode === _espe.type.invite_prefill_mode.free) + invite_object.groups_changeable ? groups_value : diff --git a/source/types.ts b/source/types.ts index 0ff9c8c..441bddf 100644 --- a/source/types.ts +++ b/source/types.ts @@ -66,39 +66,18 @@ namespace _espe.type export type invite_key = string; - /** - */ - export enum invite_prefill_mode { - hidden, - locked, - free, - }; - - - /** - * @tood use strings instead of numbers - */ - export type invite_prefill_mode_raw = ( - 0 - | - 1 - | - 2 - ); - - /** */ export type invite_object = { key : invite_key; expiry : (null | int); - membership_number_mode : invite_prefill_mode; + membership_number_changeable : boolean; membership_number_value : (null | string); - name_mode : invite_prefill_mode; + name_changeable : boolean; name_value : string; - email_address_mode : invite_prefill_mode; + email_address_changeable : boolean; email_address_value : (null | string); - groups_mode : invite_prefill_mode; + groups_changeable : boolean; groups_value : Array; }; diff --git a/tools/makefile b/tools/makefile index fa0fa98..f1554e2 100644 --- a/tools/makefile +++ b/tools/makefile @@ -71,6 +71,7 @@ ${dir_temp}/espe-core.js ${dir_temp}/espe-core.d.ts: \ ${dir_source}/api/actions/member_delete.ts \ ${dir_source}/api/actions/member_password_change_initialize.ts \ ${dir_source}/api/actions/member_password_change_execute.ts \ + ${dir_source}/api/actions/invite_list.ts \ ${dir_source}/api/actions/invite_create.ts \ ${dir_source}/api/actions/invite_examine.ts \ ${dir_source}/api/actions/invite_accept.ts \