espe/backend
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

[add] api:invitation_delete [mod] Frontend-URL-Templates nun in Konfiguration statt als Parameter von außen (conf 5 -> 6)

Browse source
This commit is contained in:
fenris 2025-10-05 23:24:47 +02:00
parent 4538782d80
commit 085d255ae7
8 changed files with 196 additions and 41 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
misc/conf-example.json
View file

@ -56,6 +56,8 @@
}, },
"connections": { "connections": {
"frontend_url_base": "http://localhost:8888", "frontend_url_base": "http://localhost:8888",
"frontend_path_template_invitation_handle": "/#invitation_handle,key={{key}}",
"frontend_path_template_password_change": "/#password_change_exec,id={{id}},key={{key}}",
"login_url": "https://login.example.org" "login_url": "https://login.example.org"
} }
}, },

35
source/api/actions/invitation_create.ts
View file

@ -35,7 +35,6 @@ namespace _espe.api
groups_value : Array<int>; groups_value : Array<int>;
expiry : (null | int); expiry : (null | int);
}; };
notification_target_url_template ?: (null | string);
send_immediatly : boolean; send_immediatly : boolean;
}, },
( (
@ -44,6 +43,7 @@ namespace _espe.api
{ {
id : _espe.type.member_id; id : _espe.type.member_id;
key : string; key : string;
url : (null | string);
} }
) )
>( >(
@ -117,11 +117,6 @@ namespace _espe.api
"expiry", "expiry",
] ]
}, },
"notification_target_url_template": {
"type": "string",
"nullable": true,
"description": "Platz-Halter: key"
},
"send_immediatly": { "send_immediatly": {
"nullable": false, "nullable": false,
"type": "boolean", "type": "boolean",
@ -145,20 +140,31 @@ namespace _espe.api
"type": "string", "type": "string",
"nullable": false, "nullable": false,
}, },
"url": {
"type": "string",
"nullable": true,
},
}, },
"additionalProperties": false, "additionalProperties": false,
"required": [ "required": [
"id", "id",
"key", "key",
"url",
] ]
}), }),
"restriction": () => restriction_logged_in, "restriction": () => restriction_logged_in,
"execution": () => async ({"input": input}) => { "execution": () => async ({"input": input}) => {
if (input === null) { if (input === null)
{
return Promise.reject(new Error("impossible")); return Promise.reject(new Error("impossible"));
} }
else { else
const invitation_info : {id : _espe.type.invitation_id; key : _espe.type.invitation_key;} = await _espe.service.invitation.create( {
const invitation_info : {
id : _espe.type.invitation_id;
key : _espe.type.invitation_key;
url : (null | string);
} = await _espe.service.invitation.create(
{ {
"name_changeable": input.data.name_changeable, "name_changeable": input.data.name_changeable,
"name_value": input.data.name_value, "name_value": input.data.name_value,
@ -171,14 +177,15 @@ namespace _espe.api
}, },
{ {
"expiry": input.data.expiry, "expiry": input.data.expiry,
"notification_target_url_template": input.notification_target_url_template,
"send_immediatly": input.send_immediatly, "send_immediatly": input.send_immediatly,
} }
); );
return Promise.resolve({ return Promise.resolve(
"status_code": 201, {
"data": invitation_info "status_code": 201,
}); "data": invitation_info
}
);
} }
} }
} }

69
source/api/actions/invitation_delete.ts Normal file
View file

@ -0,0 +1,69 @@
/*
Espe | Ein schlichtes Werkzeug zur Mitglieder-Verwaltung | Backend
Copyright (C) 2024 Christian Fraß
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public
License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later
version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see
<https://www.gnu.org/licenses/>.
*/
namespace _espe.api
{
/**
*/
export function register_invitation_delete(
rest_subject : lib_plankton.rest_http.type_rest
) : void
{
lib_plankton.rest_http.register<
int,
null
>(
rest_subject,
lib_plankton.http.enum_method.delete,
_espe.api.full_path("/invitation/delete"),
{
/**
* @todo translation
*/
"description": () => "löscht eine Einladung",
"input_schema": () => ({
"nullable": false,
"type": "integer",
}),
"output_schema": () => ({
"nullable": true,
}),
"restriction": () => restriction_logged_in,
"execution": () => async (stuff) => {
if (stuff.input === null)
{
return Promise.reject(new Error("impossible"));
}
else
{
const invitation_id : _espe.type.invitation_id = stuff.input;
await _espe.service.invitation.remove(
invitation_id
);
return Promise.resolve(
{
"status_code": 200,
"data": null
}
);
}
}
}
);
}
}

1
source/api/functions.ts
View file

@ -67,6 +67,7 @@ namespace _espe.api
_espe.api.register_invitation_list(rest_subject); _espe.api.register_invitation_list(rest_subject);
_espe.api.register_invitation_read(rest_subject); _espe.api.register_invitation_read(rest_subject);
_espe.api.register_invitation_create(rest_subject); _espe.api.register_invitation_create(rest_subject);
_espe.api.register_invitation_delete(rest_subject);
_espe.api.register_invitation_examine(rest_subject); _espe.api.register_invitation_examine(rest_subject);
_espe.api.register_invitation_accept(rest_subject); _espe.api.register_invitation_accept(rest_subject);
} }

90
source/conf.ts
View file

@ -161,6 +161,8 @@ namespace _espe.conf
}; };
connections : { connections : {
frontend_url_base : (null | string); frontend_url_base : (null | string);
frontend_path_template_invitation_handle : (null | string);
frontend_path_template_password_change : (null | string);
login_url : (null | string); login_url : (null | string);
}; };
}; };
@ -208,7 +210,7 @@ namespace _espe.conf
conf_raw : any conf_raw : any
) : void ) : void
{ {
const version : int = (conf_raw["version"] ?? 5); const version : int = (conf_raw["version"] ?? 6);
_data = { _data = {
"general": ( "general": (
((node_general) => ({ ((node_general) => ({
@ -219,7 +221,8 @@ namespace _espe.conf
"log": ( "log": (
(() => { (() => {
switch (version) { switch (version) {
case 1: { case 1:
{
return [ return [
{ {
"kind": "stdout", "kind": "stdout",
@ -233,7 +236,9 @@ namespace _espe.conf
case 2: case 2:
case 3: case 3:
case 4: case 4:
case 5: { case 5:
case 6:
{
const node_log = ( const node_log = (
conf_raw["log"] conf_raw["log"]
?? ??
@ -270,12 +275,15 @@ namespace _espe.conf
switch (version) { switch (version) {
case 1: case 1:
case 2: case 2:
case 3: { case 3:
{
return "::"; return "::";
break; break;
} }
case 4: case 4:
case 5: { case 5:
case 6:
{
return (node_server["host"] ?? "::"); return (node_server["host"] ?? "::");
break break
} }
@ -290,7 +298,8 @@ namespace _espe.conf
const kind : string = (node_database["kind"] ?? "sqlite"); const kind : string = (node_database["kind"] ?? "sqlite");
const node_database_data_raw = (node_database["data"] ?? {}); const node_database_data_raw = (node_database["data"] ?? {});
switch (kind) { switch (kind) {
case "sqlite": { case "sqlite":
{
return { return {
"kind": kind, "kind": kind,
"data": { "data": {
@ -299,14 +308,16 @@ namespace _espe.conf
}; };
break; break;
} }
case "postgresql": { case "postgresql":
{
return { return {
"kind": kind, "kind": kind,
"data": node_database_data_raw, "data": node_database_data_raw,
}; };
break; break;
} }
default: { default:
{
throw (new Error("unhandled")); throw (new Error("unhandled"));
break; break;
} }
@ -318,7 +329,8 @@ namespace _espe.conf
const kind : string = (node_email_sending["kind"] ?? "console"); const kind : string = (node_email_sending["kind"] ?? "console");
const data_raw = (node_email_sending["data"] ?? {}); const data_raw = (node_email_sending["data"] ?? {});
switch (kind) { switch (kind) {
case "regular": { case "regular":
{
return { return {
"kind": kind, "kind": kind,
"data": { "data": {
@ -328,7 +340,8 @@ namespace _espe.conf
}; };
break; break;
} }
case "redirect": { case "redirect":
{
return { return {
"kind": kind, "kind": kind,
"data": { "data": {
@ -339,7 +352,8 @@ namespace _espe.conf
}; };
break; break;
} }
case "console": { case "console":
{
return { return {
"kind": kind, "kind": kind,
"data": { "data": {
@ -347,7 +361,8 @@ namespace _espe.conf
}; };
break; break;
} }
case "drop": { case "drop":
{
return { return {
"kind": kind, "kind": kind,
"data": { "data": {
@ -355,7 +370,8 @@ namespace _espe.conf
}; };
break; break;
} }
default: { default:
{
throw (new Error("unhandled")); throw (new Error("unhandled"));
break; break;
} }
@ -400,6 +416,44 @@ namespace _espe.conf
"connections": ( "connections": (
((node_settings_connections) => ({ ((node_settings_connections) => ({
"frontend_url_base": (node_settings_connections["frontend_url_base"] ?? null), "frontend_url_base": (node_settings_connections["frontend_url_base"] ?? null),
"frontend_path_template_password_change": (() => {
switch (version)
{
case 1:
case 2:
case 3:
case 4:
case 5:
{
return null;
break;
}
case 6:
{
return (node_settings_connections["frontend_path_template_password_change"] ?? null);
break;
}
}
}) (),
"frontend_path_template_invitation_handle": (() => {
switch (version)
{
case 1:
case 2:
case 3:
case 4:
case 5:
{
return null;
break;
}
case 6:
{
return (node_settings_connections["frontend_path_template_invitation_handle"] ?? null);
break;
}
}
}) (),
"login_url": (node_settings_connections["login_url"] ?? null), "login_url": (node_settings_connections["login_url"] ?? null),
})) (node_settings["connections"] ?? {}) })) (node_settings["connections"] ?? {})
), ),
@ -408,7 +462,8 @@ namespace _espe.conf
"outputs": (() => { "outputs": (() => {
switch (version) { switch (version) {
case 1: case 1:
case 2: { case 2:
{
const node_output = (conf_raw["output"] ?? {}); const node_output = (conf_raw["output"] ?? {});
return ( return (
("authelia" in node_output) ("authelia" in node_output)
@ -427,12 +482,15 @@ namespace _espe.conf
); );
break; break;
} }
case 3: { case 3:
{
return (conf_raw["outputs"] ?? []); return (conf_raw["outputs"] ?? []);
break; break;
} }
case 4: case 4:
case 5: { case 5:
case 6:
{
const node_outputs = (conf_raw["outputs"] ?? []); const node_outputs = (conf_raw["outputs"] ?? []);
return node_outputs.map( return node_outputs.map(
(output_description : {kind : string; data : any;}) => { (output_description : {kind : string; data : any;}) => {

2
source/helpers.ts
View file

@ -259,7 +259,7 @@ namespace _espe.helpers
} }
else { else {
return lib_plankton.string.coin( return lib_plankton.string.coin(
"{{base}}/{{rest}}", "{{base}}{{rest}}",
{ {
"base": frontend_url_base, "base": frontend_url_base,
"rest": lib_plankton.string.coin(template, arguments_), "rest": lib_plankton.string.coin(template, arguments_),

37
source/services/invitation.ts
View file

@ -78,11 +78,9 @@ namespace _espe.service.invitation
}, },
{ {
"expiry": expiry = -1, "expiry": expiry = -1,
"notification_target_url_template": notification_target_url_template = null,
"send_immediatly": send_immediatly = true, "send_immediatly": send_immediatly = true,
} : { } : {
expiry ?: (null | int); expiry ?: (null | int);
notification_target_url_template ?: (null | string);
send_immediatly ?: boolean; send_immediatly ?: boolean;
} = { } = {
} }
@ -90,6 +88,7 @@ namespace _espe.service.invitation
{ {
id : _espe.type.invitation_id; id : _espe.type.invitation_id;
key : _espe.type.invitation_key; key : _espe.type.invitation_key;
url : (null | string);
} }
> >
{ {
@ -129,6 +128,19 @@ namespace _espe.service.invitation
"groups_value": groups_value, "groups_value": groups_value,
}; };
const invitation_id : _espe.type.invitation_id = await _espe.repository.invitation.create(invitation_object); const invitation_id : _espe.type.invitation_id = await _espe.repository.invitation.create(invitation_object);
const frontend_path_template_invitation_handle : (null | string) = _espe.conf.get().settings.connections.frontend_path_template_invitation_handle;
const url : (null | string) = (
(frontend_path_template_invitation_handle === null)
?
null
:
_espe.helpers.frontend_url_get(
frontend_path_template_invitation_handle,
{
"key": invitation_key,
}
)
);
// send link // send link
{ {
if (! send_immediatly) if (! send_immediatly)
@ -145,7 +157,7 @@ namespace _espe.service.invitation
(email_address_value !== "") (email_address_value !== "")
) )
&& &&
(notification_target_url_template !== null) (url !== null)
) )
) )
{ {
@ -154,19 +166,13 @@ namespace _espe.service.invitation
{ {
"details": { "details": {
"provided_address": email_address_value, "provided_address": email_address_value,
"notification_target_url_template": notification_target_url_template, "url": url,
}, },
} }
); );
} }
else else
{ {
const url : (null | string) = _espe.helpers.frontend_url_get(
notification_target_url_template,
{
"key": invitation_key,
}
);
try try
{ {
await _espe.helpers.email_send( await _espe.helpers.email_send(
@ -205,10 +211,21 @@ namespace _espe.service.invitation
return { return {
"id": invitation_id, "id": invitation_id,
"key": invitation_key, "key": invitation_key,
"url": url,
}; };
} }
/**
*/
export function remove(
id : _espe.type.invitation_id
) : Promise<void>
{
return _espe.repository.invitation.delete_(id);
}
/** /**
*/ */
export function get_by_id( export function get_by_id(

1
tools/makefile
View file

@ -74,6 +74,7 @@ ${dir_temp}/espe-core.js ${dir_temp}/espe-core.d.ts: \
${dir_source}/api/actions/invitation_list.ts \ ${dir_source}/api/actions/invitation_list.ts \
${dir_source}/api/actions/invitation_read.ts \ ${dir_source}/api/actions/invitation_read.ts \
${dir_source}/api/actions/invitation_create.ts \ ${dir_source}/api/actions/invitation_create.ts \
${dir_source}/api/actions/invitation_delete.ts \
${dir_source}/api/actions/invitation_examine.ts \ ${dir_source}/api/actions/invitation_examine.ts \
${dir_source}/api/actions/invitation_accept.ts \ ${dir_source}/api/actions/invitation_accept.ts \
${dir_source}/api/functions.ts \ ${dir_source}/api/functions.ts \