Method list

app/src/API/Handlers/ScriptsHandler.cpp:174–219

* @brief Returns the full catalog (or one kind's slice) of bundled scripts. */

 * @brief Returns the full catalog (or one kind's slice) of bundled scripts.
 */
API::CommandResponse API::Handlers::ScriptsHandler::list(const QString& id,
                                                         const QJsonObject& params)
{
  const auto kindFilter = params.value(QStringLiteral("kind")).toString();

  QJsonArray entries;
  QJsonArray kindList;
  int total = 0;

  for (const auto& k : kinds()) {
    if (!kindFilter.isEmpty() && k.id != kindFilter)
      continue;

    QJsonObject kobj;
    kobj[QStringLiteral("id")]          = k.id;
    kobj[QStringLiteral("description")] = k.description;
    kindList.append(kobj);

    const auto manifest = loadManifest(k);
    for (const auto& v : manifest) {
      const auto entry = v.toObject();
      entries.append(summarizeEntry(k, entry));
      total += 1;
    }
  }

  if (!kindFilter.isEmpty() && kindList.isEmpty()) {
    return CommandResponse::makeError(
      id,
      ErrorCode::InvalidParam,
      QStringLiteral("Unknown script kind: %1. Valid kinds: painter, "
                     "frame_parser_js, frame_parser_lua, transform_js, "
                     "transform_lua, output_widget_js")
        .arg(kindFilter));
  }

  QJsonObject result;
  result[QStringLiteral("kinds")]   = kindList;
  result[QStringLiteral("entries")] = entries;
  result[QStringLiteral("total")]   = total;
  result[QStringLiteral("hint")] =
    QStringLiteral("Each entry has {id, name, kind, datasetCount?}. Read the body with "
                   "scripts.get {kind, id} -- the body is the exact text you can pass to "
                   "the corresponding setCode endpoint after light edits.");
  return CommandResponse::makeSuccess(id, result);
}

/**
 * @brief Returns the body of one script (UTF-8 text).