Methodensignaturen JavaScript-SDK (Sender-only)
Warum?
Als Vorbereitung zur Erstellung des Javascript-SDK (#413) soll die Funktionalität und Benutzbarkeit des JavaScript-SDK auf Grundlage eines Grundgerüstes für eine Javascript-Bibliothek abgestimmt werden. Hierfür soll eine Library erstellt werden, die nur Methodensignaturen und JSDoc (aber keine Implementierungen) enthält.
Relevante Links und Bemerkungen
- SDK-Konzept im Wiki
- inoffizielles Python-SDK
- Im MVP des JavaScript-SDK ist keine Unterstützung beim Aufruf der Submission API enthalten.
- Das MVP des JavaScript-SDK hat Onlinedienste (Sender) als primäre Zielgruppe und ist noch nicht für die Nutzung im Subscriber geeignet -> Follow-Up-Issue
- Liste der URLs der Zustelldienste: https://portal.auth-testing.fit-connect.fitko.dev/v1/delivery-services
- Beispielimplementierung mit panva/jose: https://github.com/codedust/simplejose/
- Performancetests JS-Libraries: https://github.com/codedust/jwe-file-encryption-demo
- Unsere JS-Beispiele: https://git.fitko.de/fit-connect/examples/-/tree/main/javascript/encryption
- Doku-Artikel zur verschlüsselten Übertragung: https://docs.fitko.de/fit-connect/docs/getting-started/encryption
Akzeptanzkriterien
-
Die Codebasis ist in Typescript geschieben. -
Im GitLab findet sich unter https://git.fitko.de/fit-connect/sdk-javascript ein Grundgerüst des SDKs mit Methodensignaturen. -
Jede Methode ist ausführlich mittels Methodenkommentaren dokumentiert. -
Alle Methoden werfen eine NotImplementedException
(o.ä.) -
Die folgenden Funktionalitäten sind abgebildet (nicht jede Funktionalität muss zwangsläufig über eine eigene Methode abgebildet werden, ggf. reicht auch ein // TODO: implement xyz
):-
Sender: Verschlüsselung von Fachdaten (JSON, XML) mittels JWE -
Sender: Verschlüsselung von Anhängen (Binärdaten) mittels JWE -
Sender: Korrekte Erzeugung eines Metadatensatzes inkl. Hashwerte -
Sender + Subscriber: SET Parsen inkl. Signaturprüfung -
Logging
-
Durchführungsplan (vom Entwickler bei Storyplanung auszufüllen)
-
Lesen der Wiki-Seite, Klärung von offenen Fragen -
... -
... -
... -
Definition of Done wurde geprüft
Edited by Andreas Müller