Use the Platform SDK

Introduction

This how-to provides guidance on using the Platform SDK to do the following:

• Create a new app
• Open an existing app
• Get information about the repository of an app
• Delete an app
• Create a temporary working copy
• Open the working copy model
• Commit a temporary working copy
• Change the Platform SDK configurations

Platform Client

The entry point for the Mendix Platform SDK is MendixPlatformClient. In most cases, you will need to instantiate a new object from this class:

const client = new MendixPlatformClient();

Creating a New App

The platform client allows you to create a new Mendix app by simply passing the app name:

const app = await client.createNewApp("My new App");

You can pass the following options to createNewApp:

If both templateDownloadURL and templateId are left blank, the app will be created using the standard blank app template in the latest Mendix version.

Here is an example for creating a Mendix app based on the Asset Manager App template:

const app = await client.createNewApp("My Asset Management", {
    templateId: "6e66fe4d-6e96-4eb8-a2b6-a61dec37a799"
});

Opening an Existing App

The platform client allows you to open an existing app using the app ID:

const app = client.getApp("33118fbf-7053-482a-8aff-7bf1c626a6d9");

Getting Information About the Repository of the App

From the app object, you can get some information about its repository (such as the repository type, URL, and default branch name):

const repositoryInfo = app.getRepositoryInfo();

Deleting an App

The app object allows you to delete the corresponding Mendix app.

await app.delete();

Creating a Temporary Working Copy

To change your app, you need to create a temporary working copy of a particular Team Server branch, make the changes there, and then submit that working copy to Team Server:

const workingCopy = await app.createTemporaryWorkingCopy("main");

You can pass the following options to createTemporaryWorkingCopy:

Opening the Working Copy Model

After creating the working copy, you can load the model to make changes:

const model = await workingCopy.openModel();

Committing a Temporary Working Copy

After making changes, you need to commit the changes back to Team Server. Make sure to call await model.flushChanges() when committing right after making changes, as this makes sure that the SDK has been able to send the changes:

await model.flushChanges();
await workingCopy.commitToRepository();

You can pass the following options to commitToRepository:

Changing the Platform SDK Configurations

By default, the Platform SDK reads your personal access token from the environment variable (for more details, see How to Set Up your Personal Access Token). However, you can change this configuration. For example, you can load it from a file, as in this example:

setPlatformConfig({
    mendixToken: fs.readFileSync("mendix-token.txt", {encoding: "utf8"})
});

By default, the Platform SDK prints some logs to the console. You can customize the logging experience using the following APIs:

disableLogger()          // Disables all logging
enableLogger()           // Enable logging through the console
setLogger(customLogger); // Override the logger object

The custom logger object should have the following methods:

info(message?: string, ...optionalParams: any[]): any;
warn(message?: string, ...optionalParams: any[]): any;
error(message?: string, ...optionalParams: any[]): any;