Mendix SDK: low-code meets high-code

De Mendix SDK: Platform en Model

De Mendix SDK’s bestaan uit twee krachtige onderdelen: de Mendix Platform SDK en de Mendix Model SDK. Met de Platform SDK kun je nieuwe apps aanmaken, repositories beheren en wijzigingen automatisch in Team Server committen. De Model SDK biedt vervolgens volledige toegang tot het interne model van je Mendix-app. Zo kun je elk detail van je domeinmodel, microflows, widgets en meer lezen, analyseren en aanpassen.

Door deze twee SDK’s te combineren heb je één oplossing voor zowel het opzetten en beheren van Mendix-applicaties (Platform SDK) als het diepgaand automatiseren en bewerken van de inhoud ervan (Model SDK). Dit neemt een groot deel van het repetitieve en foutgevoelige werk uit handen, waardoor je efficiënter en met meer controle kunt ontwikkelen.

Waarom de Mendix Model SDK onmisbaar is

De Mendix Model SDK is een krachtige en veelzijdige toolkit die ontwikkelaars in staat stelt om elk detail van hun Mendix-apps te lezen, te analyseren en zelfs aan te passen. Met deze SDK verdwijnt veel handmatig, repetitief werk naar de achtergrond, zodat je sneller én foutlozer kunt ontwikkelen. Hieronder ontdek je waarom de Mendix Model SDK zo interessant is, plus een korte demo van hoe je ermee aan de slag kunt.

Wat maakt de Mendix Model SDK zo sterk?

• Volledige Lees- en Schrijftoegang De Mendix Model SDK geeft je toegang tot alle lagen van je app – van domeinmodellen en microflows tot webservices en widgets. Dit opent de deur naar geavanceerde analyse (bijvoorbeeld voor kwaliteitsrapporten) en automatische modelcreatie.
• Automatisering & Efficiëntie Met de SDK kun je taken die normaal gesproken handmatig en foutgevoelig zijn (zoals het toevoegen van entiteiten, updaten van microflows of genereren van documentatie), volledig automatiseren via TypeScript- of JavaScript-scripts.
• Kracht in Combinatie met de Mendix Platform SDK De Mendix Platform SDK stelt je in staat nieuwe apps te maken, repositories te beheren en wijzigingen automatisch terug te committen in Team Server, terwijl de Mendix Model SDK de binnenkant van je model toegankelijk maakt. Samen vormen ze een compleet ecosysteem voor DevOps in Mendix.

Technische hoogtepunten van de Mendix Model SDK ⚙️

• Lees en Analyseer Door toegang te hebben tot ieder detail van je appmodel kun je geavanceerde analysetools bouwen die de architectuur en kwaliteit van je Mendix-app beoordelen. Denk aan het scannen van inconsistencies of het genereren van visuele overzichten.
• Geautomatiseerde Wijzigingen Wil je automatisch nieuwe entiteiten toevoegen of bestaande microflows updaten? Met de Mendix Model SDK kun je eenvoudig scripts maken die het model op een consistente manier aanpassen.
• Ondersteuning voor TypeScript & JavaScript Werk je graag in TypeScript voor strikte typechecking, of juist in JavaScript voor snelle prototyping? De Mendix Model SDK ondersteunt beide, zodat je flexibel kunt kiezen wat voor jouw project het beste werkt.

Korte demo: starten met de Mendix Model SDK

Onderstaande stappen illustreren hoe je een kleine scriptomgeving opzet, zodat je de kracht van de Mendix Model SDK kunt ontdekken.

• Je persoonlijke toegangstoken (PAT)

Voordat je je eerste script gaat draaien, is het essentieel om een persoonlijke toegangstoken (Personal Access Token, PAT) in te stellen. Deze token moet je aanmaken in je Mendix-profiel en voorzien zijn van de juiste machtigingen. Vervolgens kun je deze token bewaren als omgevingsvariabele op je computer of opnemen in je script.

Binnen Mendix kun je drukken op jouw profiel icoon -> vervolgens op User Settings -> en als laatst links in de navbar op Developer Settings.

Hier kan je drukken op New Token en een token aanmaken met minimaal:

Model Repository – mx:modelrepository:repo:write

Sprintr Project API – mx:app:create en mx:app:delete

• Installeer benodigde packages

npm init --yes
npm install -g typescript
npm install mendixmodelsdk@latest mendixplatformsdk@latest when @types/when --save
tsc --init 

import { domainmodels } from "mendixmodelsdk";
import { MendixPlatformClient, setPlatformConfig } from "mendixplatformsdk";

async function main() {
    const client = new MendixPlatformClient();
    
    // 1. Configureer de Mendix Platform SDK met je Mendix token
    setPlatformConfig({
        mendixToken: "JouwMendixTokenHier"
    })

    // 2. Maak een nieuwe Mendix-app aan met Git als repository
    const app = await client.createNewApp(`NewApp-${Date.now()}`, {
        repositoryType: "git",
    });

    // 3. Maak een tijdelijke working copy aan van de hoofd-branch ('main')
    const workingCopy = await app.createTemporaryWorkingCopy("main");
    const model = await workingCopy.openModel();

    // 4. Pak het domeinmodel van 'MyFirstModule' en laad deze volledig in
    const domainModelInterface = model.allDomainModels().filter(dm => dm.containerAsModule.name === "MyFirstModule")[0];
    const domainModel = await domainModelInterface.load();

    // 5. Maak een nieuwe entiteit aan en geef deze een unieke naam
    const entity = domainmodels.Entity.createIn(domainModel);
    entity.name = `NewEntity_${Date.now()}`;

    // 6. Sla alle wijzigingen op en commit alles terug naar de Team Server
    await model.flushChanges();
    await workingCopy.commitToRepository("main");
}

main().catch(console.error);  

tsc demo.ts
node demo.js