From 1bd8a9fe360e3ded27e75b1373cc0ab89e451af6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20Fra=C3=9F?= Date: Mon, 31 Mar 2025 20:24:43 +0000 Subject: [PATCH 1/7] [task-193] [int] --- source/api/actions/invite_accept.ts | 62 ++++++ source/api/actions/invite_create.ts | 167 +++++++++++++++ source/api/actions/invite_examine.ts | 62 ++++++ source/api/functions.ts | 7 +- source/database.ts | 2 +- source/helpers.ts | 30 +++ source/repositories/invite.ts | 302 +++++++++++++++++++++++++++ source/services/invite.ts | 55 +++++ source/types.ts | 35 ++++ tools/makefile | 7 +- 10 files changed, 726 insertions(+), 3 deletions(-) create mode 100644 source/api/actions/invite_accept.ts create mode 100644 source/api/actions/invite_create.ts create mode 100644 source/api/actions/invite_examine.ts create mode 100644 source/repositories/invite.ts create mode 100644 source/services/invite.ts diff --git a/source/api/actions/invite_accept.ts b/source/api/actions/invite_accept.ts new file mode 100644 index 0000000..c31ae74 --- /dev/null +++ b/source/api/actions/invite_accept.ts @@ -0,0 +1,62 @@ +/* +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_examine( + rest_subject : lib_plankton.rest.type_rest + ) : void + { + register< + any, + any + >( + rest_subject, + lib_plankton.http.enum_method.post, + "/invite/accept", + { + /** + * @todo translation + */ + "description": "nimmt eine Einladung an", + /** + * @todo + */ + "input_schema": () => ({ + "nullable": true, + }), + /** + * @todo + */ + "output_schema": () => ({ + "nullable": true, + }), + "restriction": restriction_none, + "execution": async ({"input": input}) => { + /** + * @todo + */ + return Promise.resolve({ + "status_code": 501, + "data": null + }); + } + } + ); + } + +} diff --git a/source/api/actions/invite_create.ts b/source/api/actions/invite_create.ts new file mode 100644 index 0000000..b432632 --- /dev/null +++ b/source/api/actions/invite_create.ts @@ -0,0 +1,167 @@ +/* +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_create( + rest_subject : lib_plankton.rest.type_rest + ) : void + { + register< + { + membership_number_mode : int; + membership_number_value : (null | string); + name_mode : int; + name_value : string; + email_address_mode : int; + email_address_value : (null | string); + groups_value : Array; + // notification_target_url_template ?: (null | string); + }, + ( + string + | + { + id : _espe.type.member_id; + key : string; + } + ) + >( + rest_subject, + lib_plankton.http.enum_method.post, + "/invite/create", + { + /** + * @todo translation + */ + "description": "erstellt eine Einladung neues Mitglied und gibt die erzeugte ID und den erzeugten Schlüssel aus", + "input_schema": () => ({ + "type": "object", + "nullable": false, + "additionalProperties": false, + "properties": { + /* + "membership_number": { + "type": "string", + "nullable": false, + "description": "Mitgliedsnummer" + }, + "name_real_value": { + "type": "string", + "nullable": false, + "description": "Klarname" + }, + "email_address_private": { + "type": "string", + "nullable": true, + "description": "private E-Mail-Adresse" + }, + "groups": { + "nullable": false, + "type": "array", + "items": { + "type": "string", + "nullable": false, + } + }, + "notification_target_url_template": { + "type": "string", + "nullable": true, + "description": "Platz-Halter: id" + }, + */ + }, + "required": [ + "membership_number_value", + "name_value", + "email_address_value", + ] + }), + "output_schema": () => ({ + "type": "object", + "nullable": false, + "properties": { + "id": { + "type": "number", + "nullable": false, + }, + "key": { + "type": "string", + "nullable": false, + }, + }, + "additionalProperties": false, + "required": [ + "id", + "key", + ] + }), + "restriction": restriction_logged_in, + "execution": async ({"input": input}) => { + if (input === null) { + return Promise.reject(new Error("impossible")); + } + else { + if ( + (! _espe.conf.get().settings.misc.facultative_membership_number) + && + ( + (input.membership_number_value === null) + || + (input.membership_number_value === "") + ) + ) { + return Promise.resolve({ + "status_code": 400, + "data": "membership number required" + }); + } + 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_value": input.membership_number_value, + "name_mode": _espe.helpers.invite_prefill_mode_decode(input.name_mode), + "name_value": input.name_value, + "email_address_mode": _espe.helpers.invite_prefill_mode_decode(input.email_address_mode), + "email_address_value": ( + ("email_address_value" in input) + ? ( + (input.email_address_value !== "") + ? input.email_address_value + : null + ) + : null + ), + "groups_mode": _espe.helpers.invite_prefill_mode_decode(input.groups_mode), + "groups_value": input.groups_value, + } + ); + return Promise.resolve({ + "status_code": 201, + "data": invite_info + }); + } + } + } + } + ); + } + +} + diff --git a/source/api/actions/invite_examine.ts b/source/api/actions/invite_examine.ts new file mode 100644 index 0000000..9122018 --- /dev/null +++ b/source/api/actions/invite_examine.ts @@ -0,0 +1,62 @@ +/* +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_examine( + rest_subject : lib_plankton.rest.type_rest + ) : void + { + register< + any, + any + >( + rest_subject, + lib_plankton.http.enum_method.get, + "/invite/examine", + { + /** + * @todo translation + */ + "description": "gibt die Daten einer Einladung anhand ihres Schlüssels aus", + "input_schema": () => ({ + "type": "string" + "nullable": false, + }), + /** + * @todo + */ + "output_schema": () => ({ + "nullable": true, + }), + "restriction": restriction_none, + "execution": async ({"input": input}) => { + const invite_key : _espe.type.invite_key = input; + const invite_object : _espe.type.invite_object = await _espe.service.invite.examine(invite_key); + /** + * @todo + */ + return Promise.resolve({ + "status_code": 501, + "data": null + }); + } + } + ); + } + +} diff --git a/source/api/functions.ts b/source/api/functions.ts index 3a34e22..d609dbd 100644 --- a/source/api/functions.ts +++ b/source/api/functions.ts @@ -59,7 +59,12 @@ namespace _espe.api _espe.api.register_member_password_change_execute(rest_subject); } } - + // invite + { + _espe.api.register_invite_create(rest_subject); + _espe.api.register_invite_examine(rest_subject); + _espe.api.register_invite_accept(rest_subject); + } return rest_subject; } diff --git a/source/database.ts b/source/database.ts index a0945a5..abe3db1 100644 --- a/source/database.ts +++ b/source/database.ts @@ -19,7 +19,7 @@ namespace _espe.database /** */ const _compatible_revisions : Array = [ - "r6", + "r7", ]; diff --git a/source/helpers.ts b/source/helpers.ts index f5d6b43..2dffccf 100644 --- a/source/helpers.ts +++ b/source/helpers.ts @@ -248,4 +248,34 @@ namespace _espe.helpers } } + + /** + */ + export function invite_prefill_mode_encode( + invite_prefill_mode : _espe.type.invite_prefill_mode + ) : int + { + 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 : int + ) : _espe.type.invite_prefill_mode + { + switch (invite_prefill_mode) { + 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 new file mode 100644 index 0000000..86e7e4c --- /dev/null +++ b/source/repositories/invite.ts @@ -0,0 +1,302 @@ +/* +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.repository.invite +{ + + /** + */ + type type_group_chest = lib_plankton.storage.type_chest< + Array, + Record, + lib_plankton.database.type_description_create_table, + lib_plankton.storage.sql_table_common.type_sql_table_common_search_term, + Record + >; + + + /** + */ + var _core_store : ( + null + | + lib_plankton.storage.type_store< + _espe.type.invite_id, + Record, + {}, + lib_plankton.storage.type_sql_table_autokey_search_term, + Record + > + ) = null; + + + /** + */ + var _group_chest : ( + null + | + type_group_chest + ) = null; + + + /** + */ + function get_core_store( + ) : lib_plankton.storage.type_store< + _espe.type.invite_id, + Record, + {}, + lib_plankton.storage.type_sql_table_autokey_search_term, + Record + > + { + if (_core_store === null) { + _core_store = lib_plankton.storage.sql_table_autokey_store( + { + "database_implementation": _espe.helpers.database_implementation(), + "table_name": "invites", + "key_name": "id", + } + ); + } + else { + // do nothing + } + return _core_store; + } + + + /** + */ + function get_group_chest( + ) : type_group_chest + { + if (_group_chest === null) { + _group_chest = lib_plankton.storage.sql_table_common.chest( + { + "database_implementation": _espe.helpers.database_implementation(), + "table_name": "invite_groups", + "key_names": ["invite_id","group_name"], + } + ); + } + else { + // do nothing + } + return _group_chest; + } + + + /** + */ + type type_dispersal = { + core_row : Record; + group_rows : Array< + Record + >; + }; + + + /** + */ + function encode( + object : _espe.type.member_object + ) : type_dispersal + { + return { + "core_row": { + "key": object.key, + "membership_number_mode": invite_prefill_mode_encode(object.membership_number_mode), + "membership_number_value": object.membership_number_value, + "name_mode": invite_prefill_mode_encode(object.name_mode), + "name_value": object.name_value, + "email_address_mode": invite_prefill_mode_encode(object.email_address_mode), + "email_address_value": object.email_address_value, + "groups_mode": invite_prefill_mode_encode(object.groups_mode), + }, + "group_rows": ( + object.groups + .map( + group => ({ + "group_name": group, + }) + ) + ) + }; + } + + + /** + */ + function decode( + dispersal : type_dispersal + ) : _espe.type.member_object + { + return { + "key": dispersal.core_row["key"], + "membership_number_mode": invite_prefill_mode_decode(dispersal.core_row["membership_number_mode"]), + "membership_number_value": dispersal.core_row["membership_number_value"], + "name_mode": invite_prefill_mode_decode(dispersal.core_row["name_mode"]), + "name_value": dispersal.core_row["name_value"], + "email_address_mode": invite_prefill_mode_decode(dispersal.core_row["email_address_mode"]), + "email_address_value": dispersal.core_row["email_address_value"], + "groups_mode": invite_prefill_mode_decode(dispersal.core_row["groups_mode"]), + "groups_value": lib_plankton.list.sorted( + dispersal.group_rows.map(row => row["group_name"]), + (group1, group2) => ((group1 <= group2) ? 0 : 1) + ), + }; + } + + + /** + * @todo optimize + */ + export async function list( + search_term : (null | string) + ) : Promise< + Array< + { + id : _espe.type.inivite_id; + preview : { + name : string; + }; + } + > + > + { + return ( + (await get_core_store().search(null)) + .map( + ({"key": key, "preview": preview}) => ({ + "id": key, + "preview": { + "name": preview["name_value"], + } + }) + ) + ); + } + + + /** + */ + export async function read( + id : _espe.type.invite_id + ) : Promise<_espe.type.invite_object> + { + const core_row : Record = await get_core_store().read(id); + const group_hits : Array<{key : Record; preview : Record;}> = await get_group_chest().search( + { + "expression": "invite_id = $invite_id", + "arguments": {"invite_id": id} + } + ); + + const dispersal : type_dispersal = { + "core_row": core_row, + "group_rows": group_hits.map( + hit => ({ + "group_name": hit.preview["group_name"] + }) + ), + }; + + return decode(dispersal); + } + + + /** + */ + export async function create( + value : _espe.type.invite_object + ) : Promise<_espe.type.invite_id> + { + const dispersal : type_dispersal = encode(value); + + // core + const id : _espe.type.invite_id = await get_core_store().create(dispersal.core_row); + + // groups + for await (const group_row of dispersal.group_rows) { + await get_group_chest().write( + [ + id, + group_row["group_name"], + ], + { + "_dummy": null, + } + ); + } + + return id; + } + + + /** + */ + export async function delete_( + id : _espe.type.invite_id + ) : Promise + { + // groups + const hits : Array<{key : Array; preview : Record;}> = await get_group_chest().search( + { + "expression": "invite_id = $invite_id", + "arguments": {"invite_id": id} + } + ); + for (const hit of hits) { + await get_group_chest().delete(hit.key); + } + + // core + await get_core_store().delete(id); + } + + + /** + */ + export async function dump( + ) : Promise< + Array< + { + id : _espe.type.invite_id; + object : _espe.type.invite_object; + } + > + > + { + return ( + Promise.all( + (await get_core_store().search(null)) + .map(hit => hit.key) + .map( + id => ( + read(id) + .then( + (object) => ({ + "id": id, + "object": object + }) + ) + ) + ) + ) + ); + } + +} diff --git a/source/services/invite.ts b/source/services/invite.ts new file mode 100644 index 0000000..af0254d --- /dev/null +++ b/source/services/invite.ts @@ -0,0 +1,55 @@ +/* +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.service.invite +{ + + /** + */ + export function create( + ) : Promise<{id : _espe.type.invite_id; key : _espe.type.invite_key}> + { + throw (new Error("not implemented")); + } + + + /** + */ + export function examine( + key : _espe.type.invite_key + ) : Promise<{id : _espe.type.invite_id; key : _espe.type.invite_key}> + { + throw (new Error("not implemented")); + } + + + /** + */ + export function accept( + key : _espe.type.invite_key, + membership_number_value : (null | string), + name_value : (null | string), + email_address_value : (null | string) + ) : Promise + { + /** + * @todo Nutzer anlegen + * @todo Einladung löschen + */ + throw (new Error("not implemented")); + } + +} + diff --git a/source/types.ts b/source/types.ts index aa8c6c4..691c55b 100644 --- a/source/types.ts +++ b/source/types.ts @@ -55,4 +55,39 @@ namespace _espe.type password_change_token : (null | string); }; + + /** + */ + export type invite_id = int; + + + /** + */ + export type invite_key = string; + + + /** + */ + enum type invite_prefill_mode = { + hidden, + locked, + free, + }; + + + /** + * @todo expiry timestamp + */ + export type invite_object = { + key : invite_key; + membership_number_mode : invite_prefill_mode; + membership_number_value : (null | string); + name_mode : invite_prefill_mode; + name_value : string; + email_address_mode : invite_prefill_mode; + email_address_value : (null | string); + groups_mode : invite_prefill_mode; + groups_value : Array; + }; + } diff --git a/tools/makefile b/tools/makefile index 9a44cc8..c1235a8 100644 --- a/tools/makefile +++ b/tools/makefile @@ -51,9 +51,11 @@ ${dir_temp}/espe-core.js ${dir_temp}/espe-core.d.ts: \ ${dir_source}/repositories/admin.ts \ ${dir_source}/repositories/name_index.ts \ ${dir_source}/repositories/member.ts \ + ${dir_source}/repositories/invite.ts \ + ${dir_source}/services/admin.ts \ ${dir_source}/services/name_index.ts \ ${dir_source}/services/member.ts \ - ${dir_source}/services/admin.ts \ + ${dir_source}/services/invite.ts \ ${dir_source}/api/base.ts \ ${dir_source}/api/actions/meta_ping.ts \ ${dir_source}/api/actions/meta_spec.ts \ @@ -69,6 +71,9 @@ ${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_create.ts \ + ${dir_source}/api/actions/invite_examine.ts \ + ${dir_source}/api/actions/invite_accept.ts \ ${dir_source}/api/functions.ts \ ${dir_source}/conf.ts @ ${cmd_log} "compile | core …" -- 2.39.5 From eb74ecd66ffb685b265d2469a35cbaab5d52f8ad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20Fra=C3=9F?= Date: Tue, 1 Apr 2025 04:20:59 +0000 Subject: [PATCH 2/7] [task-193] [int] --- source/api/actions/invite_accept.ts | 2 +- source/api/actions/invite_create.ts | 17 ++-- source/api/actions/invite_examine.ts | 29 ++++-- source/helpers.ts | 2 +- source/repositories/invite.ts | 52 ++++++++--- source/services/invite.ts | 133 ++++++++++++++++++++++++--- source/types.ts | 4 +- 7 files changed, 191 insertions(+), 48 deletions(-) diff --git a/source/api/actions/invite_accept.ts b/source/api/actions/invite_accept.ts index c31ae74..9695aa0 100644 --- a/source/api/actions/invite_accept.ts +++ b/source/api/actions/invite_accept.ts @@ -17,7 +17,7 @@ namespace _espe.api { /** */ - export function register_invite_examine( + export function register_invite_accept( rest_subject : lib_plankton.rest.type_rest ) : void { diff --git a/source/api/actions/invite_create.ts b/source/api/actions/invite_create.ts index b432632..db9cd5d 100644 --- a/source/api/actions/invite_create.ts +++ b/source/api/actions/invite_create.ts @@ -30,7 +30,9 @@ namespace _espe.api name_value : string; email_address_mode : int; email_address_value : (null | string); + groups_mode : int; groups_value : Array; + expiry ?: (null | int); // notification_target_url_template ?: (null | string); }, ( @@ -90,6 +92,8 @@ namespace _espe.api "membership_number_value", "name_value", "email_address_value", + "groups_value", + "expiry", ] }), "output_schema": () => ({ @@ -139,17 +143,12 @@ namespace _espe.api "name_mode": _espe.helpers.invite_prefill_mode_decode(input.name_mode), "name_value": input.name_value, "email_address_mode": _espe.helpers.invite_prefill_mode_decode(input.email_address_mode), - "email_address_value": ( - ("email_address_value" in input) - ? ( - (input.email_address_value !== "") - ? input.email_address_value - : null - ) - : null - ), + "email_address_value": input.email_address_value, "groups_mode": _espe.helpers.invite_prefill_mode_decode(input.groups_mode), "groups_value": input.groups_value, + }, + { + "expiry": input.expiry, } ); return Promise.resolve({ diff --git a/source/api/actions/invite_examine.ts b/source/api/actions/invite_examine.ts index 9122018..4de355f 100644 --- a/source/api/actions/invite_examine.ts +++ b/source/api/actions/invite_examine.ts @@ -34,7 +34,7 @@ namespace _espe.api */ "description": "gibt die Daten einer Einladung anhand ihres Schlüssels aus", "input_schema": () => ({ - "type": "string" + "type": "string", "nullable": false, }), /** @@ -44,16 +44,25 @@ namespace _espe.api "nullable": true, }), "restriction": restriction_none, - "execution": async ({"input": input}) => { + "execution": ({"input": input}) => { const invite_key : _espe.type.invite_key = input; - const invite_object : _espe.type.invite_object = await _espe.service.invite.examine(invite_key); - /** - * @todo - */ - return Promise.resolve({ - "status_code": 501, - "data": null - }); + return ( + _espe.service.invite.examine(invite_key) + .then( + (invite_object) => Promise.resolve({ + "status_code": 200, + "data": { + "membership_number_mode": _espe.helpers.invite_prefill_mode_encode(invite_object.membership_number_mode), + } + }) + ) + .catch( + (error) => Promise.resolve({ + "status_code": 404, + "data": "not found" + }) + ) + ); } } ); diff --git a/source/helpers.ts b/source/helpers.ts index 2dffccf..afcdf39 100644 --- a/source/helpers.ts +++ b/source/helpers.ts @@ -270,7 +270,7 @@ namespace _espe.helpers invite_prefill_mode_encoded : int ) : _espe.type.invite_prefill_mode { - switch (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; diff --git a/source/repositories/invite.ts b/source/repositories/invite.ts index 86e7e4c..7c4b89f 100644 --- a/source/repositories/invite.ts +++ b/source/repositories/invite.ts @@ -112,22 +112,23 @@ namespace _espe.repository.invite /** */ function encode( - object : _espe.type.member_object + object : _espe.type.invite_object ) : type_dispersal { return { "core_row": { "key": object.key, - "membership_number_mode": invite_prefill_mode_encode(object.membership_number_mode), + "expiry": object.expiry, + "membership_number_mode": _espe.helpers.invite_prefill_mode_encode(object.membership_number_mode), "membership_number_value": object.membership_number_value, - "name_mode": invite_prefill_mode_encode(object.name_mode), + "name_mode": _espe.helpers.invite_prefill_mode_encode(object.name_mode), "name_value": object.name_value, - "email_address_mode": invite_prefill_mode_encode(object.email_address_mode), + "email_address_mode": _espe.helpers.invite_prefill_mode_encode(object.email_address_mode), "email_address_value": object.email_address_value, - "groups_mode": invite_prefill_mode_encode(object.groups_mode), + "groups_mode": _espe.helpers.invite_prefill_mode_encode(object.groups_mode), }, "group_rows": ( - object.groups + object.groups_value .map( group => ({ "group_name": group, @@ -142,17 +143,18 @@ namespace _espe.repository.invite */ function decode( dispersal : type_dispersal - ) : _espe.type.member_object + ) : _espe.type.invite_object { return { "key": dispersal.core_row["key"], - "membership_number_mode": invite_prefill_mode_decode(dispersal.core_row["membership_number_mode"]), + "expiry": dispersal.core_row["expiry"], + "membership_number_mode": _espe.helpers.invite_prefill_mode_decode(dispersal.core_row["membership_number_mode"]), "membership_number_value": dispersal.core_row["membership_number_value"], - "name_mode": invite_prefill_mode_decode(dispersal.core_row["name_mode"]), + "name_mode": _espe.helpers.invite_prefill_mode_decode(dispersal.core_row["name_mode"]), "name_value": dispersal.core_row["name_value"], - "email_address_mode": invite_prefill_mode_decode(dispersal.core_row["email_address_mode"]), + "email_address_mode": _espe.helpers.invite_prefill_mode_decode(dispersal.core_row["email_address_mode"]), "email_address_value": dispersal.core_row["email_address_value"], - "groups_mode": invite_prefill_mode_decode(dispersal.core_row["groups_mode"]), + "groups_mode": _espe.helpers.invite_prefill_mode_decode(dispersal.core_row["groups_mode"]), "groups_value": lib_plankton.list.sorted( dispersal.group_rows.map(row => row["group_name"]), (group1, group2) => ((group1 <= group2) ? 0 : 1) @@ -169,7 +171,7 @@ namespace _espe.repository.invite ) : Promise< Array< { - id : _espe.type.inivite_id; + id : _espe.type.invite_id; preview : { name : string; }; @@ -179,6 +181,15 @@ namespace _espe.repository.invite { return ( (await get_core_store().search(null)) + .filter( + ({"key": key, "preview": preview}) => ( + (search_term === null) + ? + true + : + (preview["key"] === search_term) + ) + ) .map( ({"key": key, "preview": preview}) => ({ "id": key, @@ -268,6 +279,23 @@ namespace _espe.repository.invite } + /** + */ + export async function identify( + key : _espe.type.invite_key + ) : Promise<_espe.type.invite_id> + { + const hits : Array<{id : _espe.type.invite_id; preview : any;}> = await list(key); + return ( + (hits.length !== 1) + ? + Promise.reject<_espe.type.invite_id>(new Error("not found")) + : + Promise.resolve<_espe.type.invite_id>(hits[0].id) + ); + } + + /** */ export async function dump( diff --git a/source/services/invite.ts b/source/services/invite.ts index af0254d..4552c32 100644 --- a/source/services/invite.ts +++ b/source/services/invite.ts @@ -18,38 +18,145 @@ namespace _espe.service.invite /** */ - export function create( + export async function create( + { + "membership_number_mode": membership_number_mode, + "membership_number_value": membership_number_value, + "name_mode": name_mode, + "name_value": name_value, + "email_address_mode": email_address_mode, + "email_address_value": email_address_value, + "groups_mode": groups_mode, + "groups_value": groups_value, + } : { + membership_number_mode : _espe.type.invite_prefill_mode; + membership_number_value : (null | string); + name_mode : _espe.type.invite_prefill_mode; + name_value : string; + email_address_mode : _espe.type.invite_prefill_mode; + email_address_value : (null | string); + groups_mode : _espe.type.invite_prefill_mode; + groups_value : Array; + }, + { + "expiry": expiry = -1, + } : { + expiry ?: (null | int); + } = { + } ) : Promise<{id : _espe.type.invite_id; key : _espe.type.invite_key}> { - throw (new Error("not implemented")); + /** + * @todo outsource to conf + */ + const default_lifetime : int = (60 * 60 * 24 * 7 * 2); + /** + * @todo proper salt + */ + const invite_key : _espe.type.invite_key = lib_plankton.sha256.get( + ( + name_value + + + "/" + + + lib_plankton.base.get_current_timestamp().toFixed(0) + ), + "secret" + ); + const invite_object : _espe.type.invite_object = { + "key": invite_key, + "expiry": ( + ((expiry !== null) && (expiry < 0)) + ? + (lib_plankton.base.get_current_timestamp() + default_lifetime) + : + expiry + ), + "membership_number_mode": membership_number_mode, + "membership_number_value": membership_number_value, + "name_mode": name_mode, + "name_value": name_value, + "email_address_mode": email_address_mode, + "email_address_value": email_address_value, + "groups_mode": groups_mode, + "groups_value": groups_value, + }; + const invite_id : _espe.type.invite_id = await _espe.repository.invite.create(invite_object); + return { + "id": invite_id, + "key": invite_key, + }; } /** + * @todo heed expiry */ - export function examine( + export async function examine( key : _espe.type.invite_key - ) : Promise<{id : _espe.type.invite_id; key : _espe.type.invite_key}> + ) : Promise<_espe.type.invite_object> { - throw (new Error("not implemented")); + const invite_id : _espe.type.invite_id = await _espe.repository.invite.identify(key); + const invite_object : _espe.type.invite_object = await _espe.repository.invite.read(invite_id); + return invite_object; } /** + * @todo heed expiry + * @todo password? */ - export function accept( + export async function accept( key : _espe.type.invite_key, membership_number_value : (null | string), name_value : (null | string), - email_address_value : (null | string) + email_address_value : (null | string), + groups_value : Array ) : Promise { - /** - * @todo Nutzer anlegen - * @todo Einladung löschen - */ - throw (new Error("not implemented")); + const invite_id : _espe.type.invite_id = await _espe.repository.invite.identify(key); + const invite_object : _espe.type.invite_object = await _espe.repository.invite.read(invite_id); + 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) + ? + membership_number_value + : + invite_object.membership_number_value + ), + "name_real_value": ( + ( + (invite_object.name_mode === _espe.type.invite_prefill_mode.free) + && + (name_value !== null) + ) + ? + name_value + : + invite_object.name_value + ), + "email_address_private": ( + ( + (invite_object.email_address_mode === _espe.type.invite_prefill_mode.free) + && + (email_address_value !== null) + ) + ? + email_address_value + : + invite_object.email_address_value + ), + "groups": ( + (invite_object.groups_mode === _espe.type.invite_prefill_mode.free) + ? + groups_value + : + invite_object.groups_value + ), + } + ); + await _espe.repository.invite.delete_(invite_id); } } - diff --git a/source/types.ts b/source/types.ts index 691c55b..907fb40 100644 --- a/source/types.ts +++ b/source/types.ts @@ -68,7 +68,7 @@ namespace _espe.type /** */ - enum type invite_prefill_mode = { + export enum invite_prefill_mode { hidden, locked, free, @@ -76,10 +76,10 @@ namespace _espe.type /** - * @todo expiry timestamp */ export type invite_object = { key : invite_key; + expiry : (null | int); membership_number_mode : invite_prefill_mode; membership_number_value : (null | string); name_mode : invite_prefill_mode; -- 2.39.5 From d3f9a88958328f7536927673bf6bdb0c4292c3e5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20Fra=C3=9F?= Date: Tue, 1 Apr 2025 20:54:10 +0000 Subject: [PATCH 3/7] [task-193] [int] --- misc/conf.example.json | 11 ++-- source/api/actions/invite_accept.ts | 44 ++++++++++++---- source/api/actions/invite_create.ts | 58 ++++++++++++++++----- source/api/actions/invite_examine.ts | 77 ++++++++++++++++++++++++++-- source/conf.ts | 3 +- source/services/invite.ts | 4 +- 6 files changed, 164 insertions(+), 33 deletions(-) diff --git a/misc/conf.example.json b/misc/conf.example.json index 0d14cc6..2227059 100644 --- a/misc/conf.example.json +++ b/misc/conf.example.json @@ -56,7 +56,12 @@ "login_url": null } }, - "output": { - "authelia": "/tmp/authelia-users.yml" - } + "outputs": [ + { + "kind": "authelia_file", + "data": { + "path": "/tmp/authelia-users.yml" + } + } + ] } diff --git a/source/api/actions/invite_accept.ts b/source/api/actions/invite_accept.ts index 9695aa0..af580ee 100644 --- a/source/api/actions/invite_accept.ts +++ b/source/api/actions/invite_accept.ts @@ -22,8 +22,14 @@ namespace _espe.api ) : void { register< - any, - any + { + key : string; + membership_number_value : (null | string); + name_value : string; + email_address_value : (null | string); + groups_value : Array; + }, + null >( rest_subject, lib_plankton.http.enum_method.post, @@ -47,13 +53,33 @@ namespace _espe.api }), "restriction": restriction_none, "execution": async ({"input": input}) => { - /** - * @todo - */ - return Promise.resolve({ - "status_code": 501, - "data": null - }); + if (input === null) { + return Promise.resolve({ + "status_code": 400, + "data": null + }); + } + else { + try { + await _espe.service.invite.accept( + input.key, + input.membership_number_value, + input.name_value, + input.email_address_value, + input.groups_value + ); + return Promise.resolve({ + "status_code": 200, + "data": null + }); + } + catch (error) { + return Promise.resolve({ + "status_code": 404, + "data": null + }); + } + } } } ); diff --git a/source/api/actions/invite_create.ts b/source/api/actions/invite_create.ts index db9cd5d..c58d82f 100644 --- a/source/api/actions/invite_create.ts +++ b/source/api/actions/invite_create.ts @@ -51,36 +51,62 @@ namespace _espe.api /** * @todo translation */ - "description": "erstellt eine Einladung neues Mitglied und gibt die erzeugte ID und den erzeugten Schlüssel aus", + "description": "erstellt eine Einladung und gibt die erzeugte ID und den erzeugten Schlüssel aus", "input_schema": () => ({ "type": "object", "nullable": false, "additionalProperties": false, "properties": { - /* - "membership_number": { - "type": "string", + "membership_number_mode": { + "type": "integer", "nullable": false, - "description": "Mitgliedsnummer" + "description": "Mitgliedsnummer | Modus" }, - "name_real_value": { - "type": "string", - "nullable": false, - "description": "Klarname" - }, - "email_address_private": { + "membership_number_value": { "type": "string", "nullable": true, - "description": "private E-Mail-Adresse" + "description": "Mitgliedsnummer | Wert" }, - "groups": { + "name_mode": { + "type": "integer", + "nullable": false, + "description": "Name | Modus" + }, + "name_value": { + "type": "string", + "nullable": true, + "description": "Name | Wert" + }, + "email_address_mode": { + "type": "integer", + "nullable": true, + "description": "E-Mail-Adresse | Modus" + }, + "email_address_value": { + "type": "string", + "nullable": true, + "description": "E-Mail-Adresse | Wert" + }, + "groups_integer": { + "type": "integer", + "nullable": true, + "description": "Gruppen | Modus" + }, + "groups_value": { "nullable": false, "type": "array", "items": { "type": "string", "nullable": false, - } + }, + "description": "Gruppen | Wert" }, + "expiry": { + "nullable": true, + "type": "intiger", + "description": "Ablaufzeitpunkt" + }, + /* "notification_target_url_template": { "type": "string", "nullable": true, @@ -89,9 +115,13 @@ namespace _espe.api */ }, "required": [ + "membership_number_mode", "membership_number_value", + "name_mode", "name_value", + "email_address_mode", "email_address_value", + "groups_mode", "groups_value", "expiry", ] diff --git a/source/api/actions/invite_examine.ts b/source/api/actions/invite_examine.ts index 4de355f..a91e19f 100644 --- a/source/api/actions/invite_examine.ts +++ b/source/api/actions/invite_examine.ts @@ -37,11 +37,72 @@ namespace _espe.api "type": "string", "nullable": false, }), - /** - * @todo - */ "output_schema": () => ({ - "nullable": true, + "type": "object", + "nullable": false, + "additionalProperties": false, + "properties": { + "expiry": { + "nullable": true, + "type": "intiger", + "description": "Ablaufzeitpunkt" + }, + "membership_number_mode": { + "type": "integer", + "nullable": false, + "description": "Mitgliedsnummer | Modus" + }, + "membership_number_value": { + "type": "string", + "nullable": true, + "description": "Mitgliedsnummer | Wert" + }, + "name_mode": { + "type": "integer", + "nullable": false, + "description": "Name | Modus" + }, + "name_value": { + "type": "string", + "nullable": true, + "description": "Name | Wert" + }, + "email_address_mode": { + "type": "integer", + "nullable": true, + "description": "E-Mail-Adresse | Modus" + }, + "email_address_value": { + "type": "string", + "nullable": true, + "description": "E-Mail-Adresse | Wert" + }, + "groups_integer": { + "type": "integer", + "nullable": true, + "description": "Gruppen | Modus" + }, + "groups_value": { + "nullable": false, + "type": "array", + "items": { + "type": "string", + "nullable": false, + }, + "description": "Gruppen | Wert" + }, + }, + "required": [ + "expiry", + "membership_number_mode", + "membership_number_value", + "name_mode", + "name_value", + "email_address_mode", + "email_address_value", + "groups_mode", + "groups_value", + ] }), "restriction": restriction_none, "execution": ({"input": input}) => { @@ -52,7 +113,15 @@ namespace _espe.api (invite_object) => Promise.resolve({ "status_code": 200, "data": { + "expiry": invite_object.expiry, "membership_number_mode": _espe.helpers.invite_prefill_mode_encode(invite_object.membership_number_mode), + "membership_number_value": invite_object.membership_number_value, + "name_mode": _espe.helpers.invite_prefill_mode_encode(invite_object.name_mode), + "name_value": invite_object.name_value, + "email_address_mode": _espe.helpers.invite_prefill_mode_encode(invite_object.email_address_mode), + "email_address_value": invite_object.email_address_value, + "groups_mode": _espe.helpers.invite_prefill_mode_encode(invite_object.groups_mode), + "groups_value": invite_object.groups_value, } }) ) diff --git a/source/conf.ts b/source/conf.ts index 7caf727..c6e4d24 100644 --- a/source/conf.ts +++ b/source/conf.ts @@ -454,7 +454,8 @@ namespace _espe.conf return (conf_raw["outputs"] ?? []); break; } - case 4: { + case 4: + case 5: { const node_outputs = (conf_raw["outputs"] ?? []); return node_outputs.map( (output_description : {kind : string; data : any;}) => { diff --git a/source/services/invite.ts b/source/services/invite.ts index 4552c32..625e50c 100644 --- a/source/services/invite.ts +++ b/source/services/invite.ts @@ -59,7 +59,7 @@ namespace _espe.service.invite + "/" + - lib_plankton.base.get_current_timestamp().toFixed(0) + Math.floor(lib_plankton.base.get_current_timestamp()).toFixed(0) ), "secret" ); @@ -68,7 +68,7 @@ namespace _espe.service.invite "expiry": ( ((expiry !== null) && (expiry < 0)) ? - (lib_plankton.base.get_current_timestamp() + default_lifetime) + (Math.floor(lib_plankton.base.get_current_timestamp()) + default_lifetime) : expiry ), -- 2.39.5 From c301789aed6dfd2894a1495cb7011e02ff04a58f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20Fra=C3=9F?= Date: Wed, 2 Apr 2025 21:01:11 +0000 Subject: [PATCH 4/7] [task-193] [int] --- source/services/invite.ts | 42 +++++++++++++++++++++++++++++++++------ 1 file changed, 36 insertions(+), 6 deletions(-) diff --git a/source/services/invite.ts b/source/services/invite.ts index 625e50c..6557ef3 100644 --- a/source/services/invite.ts +++ b/source/services/invite.ts @@ -59,7 +59,7 @@ namespace _espe.service.invite + "/" + - Math.floor(lib_plankton.base.get_current_timestamp()).toFixed(0) + lib_plankton.base.get_current_timestamp(true).toFixed(0) ), "secret" ); @@ -68,7 +68,7 @@ namespace _espe.service.invite "expiry": ( ((expiry !== null) && (expiry < 0)) ? - (Math.floor(lib_plankton.base.get_current_timestamp()) + default_lifetime) + (lib_plankton.base.get_current_timestamp(true) + default_lifetime) : expiry ), @@ -90,15 +90,45 @@ namespace _espe.service.invite /** - * @todo heed expiry + */ + function get( + key : _espe.type.invite_key + ) : Promise<_espe.type.invite_object> + { + return ( + _espe.repository.invite.identify(key) + .then( + (id) => _espe.repository.invite.read(id) + ) + ); + } + + + /** */ export async function examine( key : _espe.type.invite_key ) : Promise<_espe.type.invite_object> { - const invite_id : _espe.type.invite_id = await _espe.repository.invite.identify(key); - const invite_object : _espe.type.invite_object = await _espe.repository.invite.read(invite_id); - return invite_object; + let invite_object : (null | _espe.type.invite_object); + try { + invite_object = await get(key) + } + catch (error) { + invite_object = null; + } + if (invite_object === null) { + return Promise.reject(new Error("not found")) + } + else { + const now : int = lib_plankton.base.get_current_timestamp(true); + if ((invite_object.expiry !== null) && (invite_object.expiry >= now)) { + return Promise.reject(new Error("expired")); + } + else { + return Promise.resolve(invite_object); + } + } } -- 2.39.5 From a73e11c6f62338447d7ec687dcbe42e5e068117a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20Fra=C3=9F?= Date: Thu, 3 Apr 2025 12:18:01 +0000 Subject: [PATCH 5/7] [task-193] [int] --- source/api/actions/invite_accept.ts | 12 ++-- source/api/actions/invite_create.ts | 12 ++-- source/api/actions/invite_examine.ts | 27 ++++---- source/main.ts | 2 +- source/repositories/invite.ts | 5 +- source/services/invite.ts | 92 +++++++++++++++------------- 6 files changed, 81 insertions(+), 69 deletions(-) diff --git a/source/api/actions/invite_accept.ts b/source/api/actions/invite_accept.ts index af580ee..f15356f 100644 --- a/source/api/actions/invite_accept.ts +++ b/source/api/actions/invite_accept.ts @@ -18,10 +18,10 @@ namespace _espe.api /** */ export function register_invite_accept( - rest_subject : lib_plankton.rest.type_rest + rest_subject : lib_plankton.rest_http.type_rest ) : void { - register< + lib_plankton.rest_http.register< { key : string; membership_number_value : (null | string); @@ -33,12 +33,12 @@ namespace _espe.api >( rest_subject, lib_plankton.http.enum_method.post, - "/invite/accept", + _espe.api.full_path("/invite/accept"), { /** * @todo translation */ - "description": "nimmt eine Einladung an", + "description": () => "nimmt eine Einladung an", /** * @todo */ @@ -51,8 +51,8 @@ namespace _espe.api "output_schema": () => ({ "nullable": true, }), - "restriction": restriction_none, - "execution": async ({"input": input}) => { + "restriction": () => restriction_none, + "execution": () => async ({"input": input}) => { if (input === null) { return Promise.resolve({ "status_code": 400, diff --git a/source/api/actions/invite_create.ts b/source/api/actions/invite_create.ts index c58d82f..a3870b6 100644 --- a/source/api/actions/invite_create.ts +++ b/source/api/actions/invite_create.ts @@ -19,10 +19,10 @@ namespace _espe.api /** */ export function register_invite_create( - rest_subject : lib_plankton.rest.type_rest + rest_subject : lib_plankton.rest_http.type_rest ) : void { - register< + lib_plankton.rest_http.register< { membership_number_mode : int; membership_number_value : (null | string); @@ -46,12 +46,12 @@ namespace _espe.api >( rest_subject, lib_plankton.http.enum_method.post, - "/invite/create", + _espe.api.full_path("/invite/create"), { /** * @todo translation */ - "description": "erstellt eine Einladung und gibt die erzeugte ID und den erzeugten Schlüssel aus", + "description": () => "erstellt eine Einladung und gibt die erzeugte ID und den erzeugten Schlüssel aus", "input_schema": () => ({ "type": "object", "nullable": false, @@ -145,8 +145,8 @@ namespace _espe.api "key", ] }), - "restriction": restriction_logged_in, - "execution": async ({"input": input}) => { + "restriction": () => restriction_logged_in, + "execution": () => async ({"input": input}) => { if (input === null) { return Promise.reject(new Error("impossible")); } diff --git a/source/api/actions/invite_examine.ts b/source/api/actions/invite_examine.ts index a91e19f..dec17ee 100644 --- a/source/api/actions/invite_examine.ts +++ b/source/api/actions/invite_examine.ts @@ -18,25 +18,28 @@ namespace _espe.api /** */ export function register_invite_examine( - rest_subject : lib_plankton.rest.type_rest + rest_subject : lib_plankton.rest_http.type_rest ) : void { - register< + lib_plankton.rest_http.register< any, any >( rest_subject, lib_plankton.http.enum_method.get, - "/invite/examine", + _espe.api.full_path("/invite/examine"), { /** * @todo translation */ - "description": "gibt die Daten einer Einladung anhand ihres Schlüssels aus", - "input_schema": () => ({ - "type": "string", - "nullable": false, - }), + "description": () => "gibt die Daten einer Einladung anhand ihres Schlüssels aus", + "query_parameters": () => [ + { + "name": "key", + "required": true, + "description": "key", + } + ], "output_schema": () => ({ "type": "object", "nullable": false, @@ -77,7 +80,7 @@ namespace _espe.api "nullable": true, "description": "E-Mail-Adresse | Wert" }, - "groups_integer": { + "groups_mode": { "type": "integer", "nullable": true, "description": "Gruppen | Modus" @@ -104,9 +107,9 @@ namespace _espe.api "groups_value", ] }), - "restriction": restriction_none, - "execution": ({"input": input}) => { - const invite_key : _espe.type.invite_key = input; + "restriction": () => restriction_none, + "execution": () => ({"query_parameters": query_parameters, "input": input}) => { + const invite_key : _espe.type.invite_key = query_parameters["key"]; return ( _espe.service.invite.examine(invite_key) .then( diff --git a/source/main.ts b/source/main.ts index 05bafe4..4862439 100644 --- a/source/main.ts +++ b/source/main.ts @@ -271,7 +271,7 @@ namespace _espe "hidden": true, }), "conf_path": lib_plankton.args.class_argument.volatile({ - "indicators_long": ["conf_path"], + "indicators_long": ["conf-path"], "indicators_short": ["c"], "type": lib_plankton.args.enum_type.string, "mode": lib_plankton.args.enum_mode.replace, diff --git a/source/repositories/invite.ts b/source/repositories/invite.ts index 7c4b89f..3a6e8f9 100644 --- a/source/repositories/invite.ts +++ b/source/repositories/invite.ts @@ -157,7 +157,9 @@ namespace _espe.repository.invite "groups_mode": _espe.helpers.invite_prefill_mode_decode(dispersal.core_row["groups_mode"]), "groups_value": lib_plankton.list.sorted( dispersal.group_rows.map(row => row["group_name"]), - (group1, group2) => ((group1 <= group2) ? 0 : 1) + { + "compare_element": (group1, group2) => (group1 <= group2) + } ), }; } @@ -280,6 +282,7 @@ namespace _espe.repository.invite /** + * @todo optimize */ export async function identify( key : _espe.type.invite_key diff --git a/source/services/invite.ts b/source/services/invite.ts index 6557ef3..0ceb332 100644 --- a/source/services/invite.ts +++ b/source/services/invite.ts @@ -112,7 +112,7 @@ namespace _espe.service.invite { let invite_object : (null | _espe.type.invite_object); try { - invite_object = await get(key) + invite_object = await get(key); } catch (error) { invite_object = null; @@ -122,7 +122,7 @@ namespace _espe.service.invite } else { const now : int = lib_plankton.base.get_current_timestamp(true); - if ((invite_object.expiry !== null) && (invite_object.expiry >= now)) { + if ((invite_object.expiry !== null) && (invite_object.expiry < now)) { return Promise.reject(new Error("expired")); } else { @@ -146,47 +146,53 @@ namespace _espe.service.invite { const invite_id : _espe.type.invite_id = await _espe.repository.invite.identify(key); const invite_object : _espe.type.invite_object = await _espe.repository.invite.read(invite_id); - 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) - ? - membership_number_value - : - invite_object.membership_number_value - ), - "name_real_value": ( - ( - (invite_object.name_mode === _espe.type.invite_prefill_mode.free) - && - (name_value !== null) - ) - ? - name_value - : - invite_object.name_value - ), - "email_address_private": ( - ( - (invite_object.email_address_mode === _espe.type.invite_prefill_mode.free) - && - (email_address_value !== null) - ) - ? - email_address_value - : - invite_object.email_address_value - ), - "groups": ( - (invite_object.groups_mode === _espe.type.invite_prefill_mode.free) - ? - groups_value - : - invite_object.groups_value - ), - } - ); - await _espe.repository.invite.delete_(invite_id); + const now : int = lib_plankton.base.get_current_timestamp(true); + if ((invite_object.expiry !== null) && (invite_object.expiry < now)) { + return Promise.reject(new Error("expired")); + } + else { + 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) + ? + membership_number_value + : + invite_object.membership_number_value + ), + "name_real_value": ( + ( + (invite_object.name_mode === _espe.type.invite_prefill_mode.free) + && + (name_value !== null) + ) + ? + name_value + : + invite_object.name_value + ), + "email_address_private": ( + ( + (invite_object.email_address_mode === _espe.type.invite_prefill_mode.free) + && + (email_address_value !== null) + ) + ? + email_address_value + : + invite_object.email_address_value + ), + "groups": ( + (invite_object.groups_mode === _espe.type.invite_prefill_mode.free) + ? + groups_value + : + invite_object.groups_value + ), + } + ); + await _espe.repository.invite.delete_(invite_id); + } } } -- 2.39.5 From 05bf22a25790e3e4c35af0894d2298d988e0eb59 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20Fra=C3=9F?= Date: Sun, 6 Apr 2025 16:19:37 +0200 Subject: [PATCH 6/7] =?UTF-8?q?[task-193]=20[add]=20Funktion=20zum=20Einf?= =?UTF-8?q?=C3=BCllen=20von=20(Beispiel-)Daten?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- misc/sampledata.json | 42 +++++++++ source/data/localization/deu.loc.json | 1 + source/data/localization/eng.loc.json | 1 + source/helpers.ts | 6 +- source/main.ts | 12 +++ source/sample.ts | 119 ++++++++++++++++++++++++++ source/services/member.ts | 13 ++- source/types.ts | 12 +++ todo.md | 2 + tools/makefile | 1 + 10 files changed, 205 insertions(+), 4 deletions(-) create mode 100644 misc/sampledata.json create mode 100644 source/sample.ts create mode 100644 todo.md diff --git a/misc/sampledata.json b/misc/sampledata.json new file mode 100644 index 0000000..43a66b6 --- /dev/null +++ b/misc/sampledata.json @@ -0,0 +1,42 @@ +{ + "admins": [ + { + "name": "admin", + "email_address": "admin@example.org", + "password": "admin" + } + ], + "members": [ + { + "membership_number": "123", + "name_real": "Alexandra Ahorn", + "email_address_private": "alex-rockt@example.org", + "groups": ["auto","zug","flugzeug"] + }, + { + "membership_number": "234", + "name_real": "Berthold Buche", + "email_address_private": "bert-ohne-ernie@example.org", + "groups": ["fahrrad","zu_fuß","zug"] + }, + { + "membership_number": "345", + "name_real": "Charlotte Castania", + "email_adress_private": "charly-the-unicorn@example.org", + "groups": ["fahrrad","auto"] + } + ], + "invites": [ + { + "membership_number_mode": 1, + "membership_number_value": "456", + "name_mode": 1, + "name_value": "Daniel Distel", + "email_address_mode": 1, + "email_address_value": "duesentrieb@example.org", + "groups_mode": 1, + "groups_value": ["flugzeug","zu_fuß"] + } + ] +} + diff --git a/source/data/localization/deu.loc.json b/source/data/localization/deu.loc.json index 45b7840..3a5bcc2 100644 --- a/source/data/localization/deu.loc.json +++ b/source/data/localization/deu.loc.json @@ -17,6 +17,7 @@ "help.args.action.description": "auszuführende Aktion; Auswahl", "help.args.action.options.serve": "Server starten", "help.args.action.options.api_doc": "API-Dokumentation gemäß OpenAPI-Spezifikation auf Standard-Ausgabe schreiben", + "help.args.action.options.sample": "Datenbank mit Beispiel-Daten befüllen", "help.args.action.options.email_test": "eine Test-E-Mail senden", "help.args.action.options.expose_conf": "Vollständige Konfiguration ausgeben", "help.args.action.options.password_image": "Passwort-Abbild errechnen und auf Standard-Ausgabe schreiben", diff --git a/source/data/localization/eng.loc.json b/source/data/localization/eng.loc.json index f9e73af..b822ef3 100644 --- a/source/data/localization/eng.loc.json +++ b/source/data/localization/eng.loc.json @@ -17,6 +17,7 @@ "help.args.action.description": "action to executo; options", "help.args.action.options.serve": "start server", "help.args.action.options.api_doc": "write API documentation according to OpenAPI specification to stdout", + "help.args.action.options.sample": "fill database with sample data", "help.args.action.options.email_test": "send a test e-mail", "help.args.action.options.expose_conf": "write complete configuration to stdout", "help.args.action.options.password_image": "compute password image and write to stdout", diff --git a/source/helpers.ts b/source/helpers.ts index afcdf39..4adf64b 100644 --- a/source/helpers.ts +++ b/source/helpers.ts @@ -253,7 +253,7 @@ namespace _espe.helpers */ export function invite_prefill_mode_encode( invite_prefill_mode : _espe.type.invite_prefill_mode - ) : int + ) : _espe.type.invite_prefill_mode_raw { switch (invite_prefill_mode) { case _espe.type.invite_prefill_mode.hidden: return 0; @@ -267,7 +267,7 @@ namespace _espe.helpers /** */ export function invite_prefill_mode_decode( - invite_prefill_mode_encoded : int + invite_prefill_mode_encoded : _espe.type.invite_prefill_mode_raw ) : _espe.type.invite_prefill_mode { switch (invite_prefill_mode_encoded) { @@ -277,5 +277,5 @@ namespace _espe.helpers default: throw (new Error("unhandled encoded invite prefill mode: " + String(invite_prefill_mode_encoded))); } } - + } diff --git a/source/main.ts b/source/main.ts index 4862439..7ac590b 100644 --- a/source/main.ts +++ b/source/main.ts @@ -204,6 +204,10 @@ namespace _espe "name": "api-doc", "description": lib_plankton.translate.get("help.args.action.options.api_doc") }, + { + "name": "sample", + "description": lib_plankton.translate.get("help.args.action.options.sample"), + }, { "name": "email-test", "description": lib_plankton.translate.get("help.args.action.options.email_test") @@ -360,6 +364,14 @@ namespace _espe ); break; } + case "sample": { + const path : string = args["arg1"]; + if (path === null) { + throw (new Error("SYNTAX: sample ")); + } + _espe.sample.fill_by_path(path); + break; + } case "email-test": { await _espe.helpers.email_send( ( diff --git a/source/sample.ts b/source/sample.ts new file mode 100644 index 0000000..0d4f0d8 --- /dev/null +++ b/source/sample.ts @@ -0,0 +1,119 @@ +/* +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.sample +{ + + /** + */ + type type_data = { + admins : Array< + { + name : string; + email_address : (null | string); + password : string; + } + >; + members : Array< + { + membership_number : string; + name_real : string; + email_address_private : (null | string); + groups : Array; + } + >; + invites : Array< + { + membership_number_mode : _espe.type.invite_prefill_mode_raw; + membership_number_value : string; + name_mode : _espe.type.invite_prefill_mode_raw; + name_value : string; + email_address_mode : _espe.type.invite_prefill_mode_raw; + email_address_value : (null | string); + groups_mode : _espe.type.invite_prefill_mode_raw; + groups_value : Array; + } + >; + }; + + + /** + */ + export async function fill( + data : type_data + ) : Promise + { + // admins + { + for (const admin_raw of data.admins) { + const admin_id : _espe.type.admin_id = await _espe.service.admin.add( + admin_raw.name, + admin_raw.email_address, + admin_raw.password, + ); + } + } + // members + { + for (const member_raw of data.members) { + const member_id : _espe.type.member_id = await _espe.service.member.project( + { + "membership_number": member_raw.membership_number, + "name_real_value": member_raw.name_real, + "email_address_private": member_raw.email_address_private, + "groups": member_raw.groups + }, + { + "silent": true, + } + ); + } + /** + * @todo passwords + */ + } + // invites + { + 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_value": invite_raw.membership_number_value, + "name_mode": invite_raw.name_mode, + "name_value": invite_raw.name_value, + "email_address_mode": invite_raw.email_address_mode, + "email_address_value": invite_raw.email_address_value, + "groups_mode": invite_raw.groups_mode, + "groups_value": invite_raw.groups_value, + } + ); + } + } + } + + + /** + */ + export async function fill_by_path( + path : string + ) : Promise + { + const content : string = await lib_plankton.file.read(path); + const data : type_data = (lib_plankton.json.decode(content) as type_data); + await fill(data); + } + +} + diff --git a/source/services/member.ts b/source/services/member.ts index 9ee771c..d8d4733 100644 --- a/source/services/member.ts +++ b/source/services/member.ts @@ -310,6 +310,12 @@ namespace _espe.service.member name_real_value : string; email_address_private : (null | string); groups : Array; + }, + { + "silent": silent = false, + } : { + silent ?: boolean; + } = { } ) : Promise<_espe.type.member_id> { @@ -331,7 +337,12 @@ namespace _espe.service.member "groups": data.groups, }; const id : _espe.type.member_id = await _espe.repository.member.create(object); - signal_change(); + if (silent) { + // do nothing + } + else { + signal_change(); + } return id; } diff --git a/source/types.ts b/source/types.ts index 907fb40..0ff9c8c 100644 --- a/source/types.ts +++ b/source/types.ts @@ -73,6 +73,18 @@ namespace _espe.type locked, free, }; + + + /** + * @tood use strings instead of numbers + */ + export type invite_prefill_mode_raw = ( + 0 + | + 1 + | + 2 + ); /** diff --git a/todo.md b/todo.md new file mode 100644 index 0000000..3a53d88 --- /dev/null +++ b/todo.md @@ -0,0 +1,2 @@ +- Niederschreiben (Logging) von geheimen Angaben verhindern + diff --git a/tools/makefile b/tools/makefile index c1235a8..fa0fa98 100644 --- a/tools/makefile +++ b/tools/makefile @@ -86,6 +86,7 @@ main: core ${dir_build}/espe data ${dir_temp}/espe-main-raw.js: \ ${dir_lib}/plankton/plankton.d.ts \ ${dir_temp}/espe-core.d.ts \ + ${dir_source}/sample.ts \ ${dir_source}/main.ts @ ${cmd_log} "compile | main …" @ ${cmd_mkdir} $(dir $@) -- 2.39.5 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 7/7] [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 \ -- 2.39.5