Introduktion

Formål

Formålet med dette dokument er at beskrive hvordan et udviklingsmiljø, til videreudvikling af NAP SDK, skal sættes op, kodens struktur, samt hvordan koden bygges, deployes og testes.

Nap-typescript-sdk

Udviklingssetup og targets:

Installer afhængigheder

Installer dependecies ved at køre `npm install --registry https://nexus.nspop.dk/nexus/repository/nsp-npm/`

Byg

Kør "npm run build" for at bygge projektet. Dette giver et output i dist/ folderen. 

Unit tests

For at køre unit tests med Karma kør "npm run test". Det generere en coverage rapport i coverage/ mappen.

CI

For at bygge SDK til CI køre "npm run ci:build". Jenkins filen beskriver jenkins pipelinen.

Der kan laves snapshots og release-candidates fra jenkins.

Linting

Kør "npm run lint" for linting.

Dokumentation

For at generere dokumentation til koden, kør "npm run doc". Dokumentation ligger i docs/ mappen.

Projektstruktur

NAPMessages

NAPMessage er meget inspireret af FHIR / FHIRcast (https://fhircast.org/specification/Feb2020Ballot/), og er udgangspunktet i NAPMessage datastrukturen og grundlaget for de events der er implementeret i eventkataloget version 1. Eventkataloget fungerer som versionering af NAP events. 

Et anvenderprojekt definerer hvilken version af eventkataloget den implementerer. Dette fungerer som en kontrakt således, at et givent værtssytem ved et givent projekt kan håndtere en række events.

Skal der implementeres nye events kræver det nyt release af nap-typescript-sdk'et.

Bro

En NAP bridge er et simpelt interface med en send-funktion og en callback handle.

interface NAPHostBridge {
  setCallback: (handler: { handle: (message: string) => void }) => void;
  send: (message: string) => void;
}

Et værtssystem skal ligge en sådan bridge på window.NAP.

Et eksempel på hvordan bridgen injectes i nap-java-host:

package dk.sds.nap.integrations;

import java.io.IOException;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;

import dk.sds.nap.scenes.WebPane;
import netscape.javascript.JSObject;

public class EmbeddedJavascriptIntegration extends AbstractBaseIntegration implements Integration {
    private static ObjectMapper objectMapper = new ObjectMapper();
    public NAPBridge bridge = new NAPBridge();

    public EmbeddedJavascriptIntegration(final WebPane webPane) {
        webPane.addInterface("NAP", bridge);
    }

    @Override
    public void send(NAPEvent event) {
        System.out.println("napevent send: " + event.getType());
        System.out.println("payload: " + event.getPayload());
        final String eventRawJSONString;
        try {
            eventRawJSONString = objectMapper.writeValueAsString(event);
            this.bridge.bridge.call("handle", eventRawJSONString);
        } catch (JsonProcessingException jsonProcessingException) {
            System.out.println(this.getClass().getName()+ " " + jsonProcessingException);
        }
    }

    public class NAPBridge {
        private JSObject bridge;

        public void send(String rawEventString) {
            try {
                System.out.println(this.getClass().getName() + " send(): " + rawEventString);
                NAPEvent event = objectMapper.readValue(rawEventString, NAPEvent.class);
                notifyListeners(event);
            } catch (IOException ioException) {
                System.out.println(this.getClass().getName() + " " + ioException);
            }
        }

        public void setCallback(JSObject bridge) {
            System.out.println(this.getClass().getName() + " setCallBack(): " +  bridge);
            this.bridge = bridge;
        }
    }
}

Når "nap-typescript-sdk" kalder "createNAP()", bruger den referencen til denne bridge. Håndtaget til sendMessage() bruges til at initialisere en toHost kanal (fra det indlejrede system til værtssystemet). Håndtaget for setCallback bruges for at opsætte en fromHost kanal (fra værtssytemet til det indlejrede system)

FhirValueGetter

Der er defineret et fhir-value-getter namespace med hjælpe funktioner til mappe NAPMessages til de værdier, som egentlig er interessante.

FhirValueSetter

Der er defineret et fhir-value-setter namespace, som indeholder enums af typiske værdier, der skal sættes i NAPMessages.

Nap-angular-sdk

Indeholder 3 "projekter".

1. Et angular workspace i src-folderen. Dette kræves af angular framework for at serve et library.
2. Det egentlige nap-angular-sdk, som warapper nap-typescript-sdk, i projects/nap-angular
   1. ng-package.json definerer de filer der skal pakkes og publishes.
3. En test implementering, som bruger nap-angular-sdk i projects/test. Heri er injected en fakebridge i index.html.
   Dette er den egentlige test af SDKet, og der køres derfor ingen unit tests. Sendte beskeder printes i console.log.

Installer afhængigheder

Installer dependecies ved at køre npm install --registry https://nexus.nspop.dk/nexus/repository/nsp-npm/

Udviklingserver

For at starte en web pack dev server kør "npm run start:dev".  Dette vil starte test implementering på (projects/test) http://localhost:4300/. 

CI

Jenkins filen beskriver jenkins pipelinen.

Der kan laves snapshots og release-candidates fra jenkins.

Byg

Kør "npm run build" for at bygge projektet. Dette giver et output i dist/ folderen. Brug "npm run build-prod" for et produktionsbyg.

Linting

Kør `npm run lint` for linting.

Dokumentation

For at generere dokumentation til koden, kør "npm run doc". Dokumentation ligger i docs/ mappen.

Nap-react-sdk

Indeholder 2 "projekter".

1. Det egentligt nap-react-sdk i src
   
   1. Npm package mangeren bruger .npmignore til at ignore visse filer så som node_modules og example, når pakken skal bundles og publishes
2. Et eksempel implementering, som motionerer nap-react-sdk i example/src. Heri er injected en fakebridge i index.html. Dette er den egentlige test af SDKet, og der køres ingen unit tests. Sendte beskeder printes i console.log.

Installer afhængigheder

Installer dependecies ved at køre npm install --registry https://nexus.nspop.dk/nexus/repository/nsp-npm/

Byg

Kør "npm run build" for at bygge projektet. Dette giver et output i dist/ folderen. Brug "npm run build-prod" for et produktionsbyg.

CI

Jenkins filen beskriver jenkins pipelinen.

Der kan laves snapshots og release-candidates fra jenkins.

Development server

Kør "npm run start" for at bygge sdk'et. Dette giver et output i dist/ folderen. Derefter navigere ind i example/ folderen og køre "npm run start".  Derefter vil en dev server med live deployment af både eksempel-projektet og SDK'et køre på http://localhost:3000/.

Linting

Kør "npm run lint" for linting.

Documentation

For at generere dokumentation til koden, kør "npm run doc". Dokumentation ligger i docs/ mappen.