@trives/mxsmartstuff v1.4.1

TODO: volledig herschrijven!

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 @wiemersteenbeek/mxsdkcore.

Before you start:

• 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/

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: does tsc
• npm run test: runs unit tests

Todo:

• Setup unit tests with Jest(?) + remove current test folder
• Index.js/ts
• How to prevent referring to objects with long paths - e.g. build/simplesdk/etc.
• Split up reader, reporter and generator?

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

How to: Install: npm i @wiemersteenbeek/mxsdkcore (log in as @wiemersteenbeek first) Publish: npm login npm version 1.0.0 (or whatever version you want to publish) npm publish

Known issues: During a Docker build process, the process might not be able to access this npm-repository. This can be solved by temporary making the package public. To do: tweak the build process so that it can use private packages.