Method outputWidgetDryRun

app/src/API/Handlers/ProjectHandler.cpp:6242–6299

* @brief Compiles an output-widget transmit() in the live helper environment without applying. */

 * @brief Compiles an output-widget transmit() in the live helper environment without applying.
 */
API::CommandResponse API::Handlers::ProjectHandler::outputWidgetDryRun(const QString& id,
                                                                       const QJsonObject& params)
{
  if (!params.contains(QStringLiteral("code")))
    return CommandResponse::makeError(
      id, ErrorCode::MissingParam, QStringLiteral("Missing required parameter: code"));

  const auto code = params.value(QStringLiteral("code")).toString();
  DataModel::FrameBuilder::instance().refreshTableStoreFromProjectModel();

  QJSEngine engine;
  engine.installExtensions(QJSEngine::ConsoleExtension | QJSEngine::GarbageCollectionExtension);
#ifdef BUILD_COMMERCIAL
  Widgets::Output::Base::installProtocolHelpers(engine);
#endif
  DataModel::FrameBuilder::instance().injectTableApiJS(&engine);

  const auto wrapped =
    QStringLiteral("(function() { %1\n"
                   "return typeof transmit === 'function' ? transmit : undefined; })()")
      .arg(code);
  auto transmitFn = engine.evaluate(wrapped, QStringLiteral("output_widget_dryrun.js"));
  if (transmitFn.isError()) {
    QJsonObject result;
    result[QStringLiteral("ok")] = false;
    result[QStringLiteral("compileError")] =
      transmitFn.property(QStringLiteral("message")).toString();
    result[QStringLiteral("line")] = transmitFn.property(QStringLiteral("lineNumber")).toInt();
    return CommandResponse::makeSuccess(id, result);
  }

  if (!transmitFn.isCallable()) {
    QJsonObject result;
    result[QStringLiteral("ok")] = false;
    result[QStringLiteral("compileError")] =
      QStringLiteral("Script compiled but did not define transmit(value). Output-widget "
                     "transmit scripts MUST define `function transmit(value)` returning the "
                     "bytes to send (a Uint8Array, a byte array, or a string). The function "
                     "is named `transmit`, not `output` or `send`.");
    return CommandResponse::makeSuccess(id, result);
  }

  QJsonObject result;
  result[QStringLiteral("ok")]          = true;
  result[QStringLiteral("hasTransmit")] = true;
  if (params.contains(QStringLiteral("inputValue")))
    result[QStringLiteral("sampleRun")] =
      runOutputWidgetSample(engine,
                            transmitFn,
                            params.value(QStringLiteral("inputValue")),
                            params.value(QStringLiteral("hex")).toBool());
  else
    result[QStringLiteral("hint")] =
      QStringLiteral("Compiled and transmit(value) is defined. Pass inputValue (and hex:true "
                     "for hex byte input) to also execute it and see the produced bytes.");

  return CommandResponse::makeSuccess(id, result);
}