[Feature] [EDT-1086] Improved get/set for Actions

[Matthiee]

This PR improves Action Typings with the engine changes.

Get properties

The getter properties on objects will now reflect the actual value vs snapshot value before.

Example:

const frame = studio.frames.byName("bottle");
console.log(frame.width); // 100
frame.setWidth(200);
console.log(frame.width); // 200

Set methods

Setter methods have been added on studio objects as a shorthand for studio.[controller].[setMethod].

See PR for the full list of setter methods that have been added.

Example;

const frame = studio.frames.byName("bottle");
frame.setWidth(200); // shorthand for studio.frames.setWidth("bottle", 200);

const layout = studio.layouts.byName("Skyscraper");
layout.select(); // shorthand for studio.layouts.select("Skyscraper");

const variable = studio.variables.byName("list");
variable.setValue("Orange"); // shorthand for studio.variables.setValue("list", "Orange");

Improved argument types

In order to use actions more easily in advanced scenarios, the argument types for certain methods have been extended.

Example:

// Inside a List variable value changed trigger
const layoutToSelect = triggers.changedVariable.value; // Returns the selected item from the List variable

// The following will now work.
// Previously: Argument of type 'VariableValue' is not assignable to parameter of type 'string'.
studio.layouts.select(layoutToSelect); 

Example named objects:

studio.variables.setValue(studio.variables.byName("myVariable"), "some value"); // .name no longer required

const imageVariable = studio.variables.byName("myImageVariable");
const imageFrame = studio.variables.byName("myImageFrame");

imageFrame.assignVariable(imageVariable); // .name no longer required
studio.frames.assignVariable(imageVariable, imageFrame); // .name no longer required

Related tickets

• EDT-1086

[github-actions]

Coverage report can be checked at https://chili-dev.azureedge.net/sdk/coverage/331/coverage.html

[github-actions]

Unit Test Results

    1 files    30 suites   26s ⏱️
270 tests 270 ✔️ 0 💤 0 ❌
271 runs  271 ✔️ 0 💤 0 ❌

Results for commit a5f027b.

♻️ This comment has been updated with latest results.