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

[task-193] [int]

Browse source
This commit is contained in:
roydfalk 2025-04-12 10:20:58 +00:00
parent 05bf22a257
commit d4fdebceca
12 changed files with 233 additions and 144 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
misc/sampledata.json
View file

@ -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ß"]
}
]

44
source/api/actions/invite_create.ts
View file

@ -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<string>;
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,
},
{

38
source/api/actions/invite_examine.ts
View file

@ -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,
}
})

86
source/api/actions/invite_list.ts Normal file
View file

@ -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
<https://www.gnu.org/licenses/>.
*/
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
});
}
}
);
}
}

1
source/api/functions.ts
View file

@ -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);

50
source/helpers.ts
View file

@ -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)));
}
}
}

16
source/repositories/invite.ts
View file

@ -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<string>(
dispersal.group_rows.map(row => row["group_name"]),
{

24
source/repositories/member.ts
View file

@ -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"],

16
source/sample.ts
View file

@ -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<string>;
}
>;
@ -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,
}
);

64
source/services/invite.ts
View file

@ -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<string>;
},
{
@ -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
:

29
source/types.ts
View file

@ -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<string>;
};

1
tools/makefile
View file

@ -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 \