@trives/mxsdkcore NPM

Introduction: This package is the core of the Mendix SDK. It is a wrapper around the Mendix Model API and can be used in your own projects to interact with the Mendix Platform. It is written in TypeScript and can be used in both TypeScript and JavaScript projects. It is published on NPM as @trives/mxsdkcore.

Before you start:

make sure NodeJS is at v18.16.0 (or later)
Make sure you have a Mendix account and are familiar with things like its domain model, microflows, security etc.
Set up your environment: https://docs.mendix.com/apidocs-mxsdk/mxsdk/setting-up-your-development-environment/
Set up your personal access token: https://docs.mendix.com/apidocs-mxsdk/mxsdk/setup-your-pat/
after downloading this repository: npm install or npm update

Background:

Mendix SDK reference guide: https://docs.mendix.com/apidocs-mxsdk/mxsdk/sdk-refguide/
On JavaScript, TypeScript and their differences: https://docs.mendix.com/apidocs-mxsdk/mxsdk/javascript-typescript-resources/
Presenting the Mendix Platform SDK and Model API: https://www.mendix.com/blog/presenting-the-mendix-platform-sdk/
Latest API doc: https://apidocs.rnd.mendix.com/platformsdk/latest/index.html

Run:

npm run clean: to clean build directory
npm run build: to compile ts to js (tsc)
npm run test: runs unit tests

Publish as package:

npm version
npm publish (if not logged in you will be required to do so)

Todo:

Setup unit tests with Jest(?)
Index.js/ts
How to prevent referring to objects with long paths - e.g. build/simplesdk/etc.
Every runtime probably needs to be client specific, since SetPlatformConfig() only allows for one mendixtoken at a time
Add SimpleSession()? Less need for it, since multitenancy is probably not possible (see previous point), but is cleaner instead of pretending to keep a different mendixtoken for each model...
Make unit/integration tests work. Keep Jest, different framework or 'just' a script.
Add (Simple)App and Session

References: GitHub: https://github.com/WiemerSteenbeek/MxSimpleCore (private!) NPM: https://www.npmjs.com/package/@wiemersteenbeek/mxsdkcore (private!)