Client API updates #9709

exec-astraea · 2025-06-19T14:19:18Z

In Mendix 10.22 we introduced the new Client API. It uses promises and works as a modern JS module instead of being attached to the global window object.

This PR removes all mentions of the old mx. and logger APIs for Mendix 10 and 11. JS actions guide was also partially rewritten using new APIs.

Note that docs still mention mx.session.getConfig("csrftoken") in Mendix 10 guide. getCSRFToken was introduced quite late (Mendix 10.23). Plus, at the moment there is no way to import the new API in pluggable widgets.
We'll revise these docs after 10.6, 10.12 and 10.18 are out of support and after getCSRFToken is availaible in Pluggable Widgets.

…tCSRFToken method instead

exec-astraea · 2025-06-19T14:25:37Z

Mendix 11 guide for Session Management already mentions the new login method. I decided not to touch Mendix 10 version for now. The guide is complicated enough as it is and adding blocks like "if you're below 10.22 use X otherwise Y" would make it worse 😄
We'll update the guide after MTS versions are out of support.

WimJongeneel · 2025-06-23T11:25:37Z

content/en/docs/howto/extensibility/build-javascript-actions/write-javascript-github.md

+                const mxObject = await create({ entity: "HowTo.GitHubUser" });
+                // Dynamically set attributes
+                mxObject.getAttributes()
+                    .forEach(function(attributeName) {


I think we can just use arrow functions as well in the examples?

WimJongeneel · 2025-06-23T11:26:01Z

content/en/docs/howto/extensibility/build-javascript-actions/write-javascript-github.md

+                const mxObject = await create({ entity: userEntity });
+                // Dynamically set attributes
+                mxObject.getAttributes()
+                    .forEach(function(attributeName) {


I think we can just use arrow functions as well in the examples?

MarkvanMents

I have a couple of comments about the things which have been taken out of the Mendix 10 version of the document and how that affects customers who are still on earlier versions of Mendix (10.12 or 10.18).
Can you have a look and see if we need to keep some of that documentation to support customers who cannot upgrade quickly.

MarkvanMents · 2025-06-24T07:40:49Z

content/en/docs/howto/extensibility/best-practices-javascript-actions.md

@@ -290,36 +289,6 @@ Use the following code to employ an asynchronous return for when your nanoflow n

 Many APIs and functions are designed in an asynchronous way, and use callback functions or promises. A JavaScript action expects a promise to be returned. The promise should be resolved with the return value as expected in the action.

-#### Understanding Promises
-
-A `Promise` object represents the eventual completion (or failure) of an asynchronous operation and its resulting value.


I see there are lots of mentions of Promise still in this document. Do we still need this explanation of what a Promise is, even if you don't need to use it on callback APIs?

I see the next section is also about Promises,

MarkvanMents · 2025-06-24T07:42:03Z

content/en/docs/howto/extensibility/best-practices-javascript-actions.md

-* Use the standard Mendix Client to show a confirmation dialog box with an **OK** and a **Cancel** button (the execution of the nanoflow halts until the user clicks one of the buttons) 
-* The resolve will return a Boolean value, which is used as the return value of the action 
-* In the nanoflow, the return variable can be used for an alternative flow for confirmation and cancel
-
 #### Understanding Promise API


Reading the section below this, I'm not sure why it is titled "Promise API" but the whole text is about "Fetch API"?

MarkvanMents · 2025-06-24T07:53:08Z

content/en/docs/howto10/extensibility/best-practices-javascript-actions.md

-#### Understanding Promises
-
-A `Promise` object represents the eventual completion (or failure) of an asynchronous operation and its resulting value.
-
-Use the following code to wrap a callback API in a promise:
-
-```javascript
-function AskConfirmation(question) {
-    // BEGIN USER CODE
-    return new Promise(function (resolve) {
-        mx.ui.confirmation({
-            content: question,
-            handler: function() {
-                resolve(true);
-            },
-            onCancel: function() {
-                resolve(false);
-            }
-        });
-    });
-    // END USER CODE
-}
-```
-


I think this is still needed for customers who are using an MTS version of Mendix 10?

MarkvanMents · 2025-06-24T07:53:57Z

content/en/docs/howto10/extensibility/best-practices-javascript-actions.md

+import { create } from "mx-api/data"
+
+try {
+    const cat = await create({ entity: "MyFirstModule.Cat" })
+    console.log("Object created on server:", cat);
+} catch (err) {
+    console.error("Could not commit object:", err);
+}
 ```

-For more information on creating objects, consult the [Create](https://apidocs.rnd.mendix.com/10/client/mx.data.html#.create) section of the *Mendix Client API*.
+For more information on creating objects, consult the [Create](https://apidocs.rnd.mendix.com/10/client-mx-api/module-mx-api_data.html#.create) section of the *Mendix Client API*.


I think we need to keep the old information as well for those who are still using MTS versions of Mendix 10.

MarkvanMents · 2025-06-24T07:54:51Z

content/en/docs/howto10/extensibility/build-javascript-actions/write-javascript-github.md

+        async function createGitHubUser(user) {
+            try {
+                const mxObject = await create({ entity: "HowTo.GitHubUser" });
+                mxObject.set("login", user.login);
+                mxObject.set("avatar_url", user.avatar_url);
+                return mxObject;
+            } catch(err) {
+                throw new Error("Could not create object:" + err.message)
+            }


Will this work in MTS versions of Mendix 10 (e.g. 10.18)

exec-astraea added 4 commits June 19, 2025 15:13

Updated docs that mention mx.session.getConfig("csrftoken") to use ge…

6974a0c

…tCSRFToken method instead

Updated docs that use mx.data.create to use the new APIs

002e67b

Removed obsolete section on wrapping old APIs in promises

2de1bd5

Use window.reload() instead of mx.reloadWithState()

5aee559

MarkvanMents self-requested a review June 20, 2025 13:04

MarkvanMents assigned MarkvanMents and quinntracy Jun 20, 2025

MarkvanMents added the Needs language review label Jun 20, 2025

WimJongeneel reviewed Jun 23, 2025

View reviewed changes

exec-astraea and others added 5 commits June 23, 2025 13:47

Modernized JS syntax in the examples

edc993b

Revise

591337e

Revise

457d1eb

Revise

47cd100

Change version wording

4165acc

WimJongeneel approved these changes Jun 24, 2025

View reviewed changes

MarkvanMents added 2 commits June 24, 2025 10:23

Minor proofreading changes

ccd7a3a

Proofread

c41eab4

MarkvanMents reviewed Jun 24, 2025

View reviewed changes

MarkvanMents added the Needs R&D technical verification label Jun 26, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Client API updates #9709

Client API updates #9709

exec-astraea commented Jun 19, 2025 •

edited

Loading

Uh oh!

exec-astraea commented Jun 19, 2025

Uh oh!

WimJongeneel Jun 23, 2025

Uh oh!

exec-astraea Jun 23, 2025

Uh oh!

WimJongeneel Jun 23, 2025

Uh oh!

exec-astraea Jun 23, 2025

Uh oh!

MarkvanMents left a comment

Uh oh!

MarkvanMents Jun 24, 2025

Uh oh!

MarkvanMents Jun 24, 2025

Uh oh!

MarkvanMents Jun 24, 2025

Uh oh!

MarkvanMents Jun 24, 2025

Uh oh!

MarkvanMents Jun 24, 2025

Uh oh!

Uh oh!

Client API updates #9709

Are you sure you want to change the base?

Client API updates #9709

Conversation

exec-astraea commented Jun 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

exec-astraea commented Jun 19, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MarkvanMents left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

exec-astraea commented Jun 19, 2025 •

edited

Loading