ash/scanner/scanner_feedback.h

// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef ASH_SCANNER_SCANNER_FEEDBACK_H_
#define ASH_SCANNER_SCANNER_FEEDBACK_H_

#include <cstddef>
#include <optional>
#include <string>

#include "ash/ash_export.h"
#include "base/values.h"

namespace manta::proto {
class ScannerAction;
}

namespace ash {

// Converts a `manta::proto::ScannerAction` into an "externally tagged"
// `base::Value::Dict` for use in filing feedback.
// Required as Chromium's lite runtime for Protobuf does not support descriptors
// and, by extension, text format.
ASH_EXPORT base::Value::Dict ScannerActionToDict(
    manta::proto::ScannerAction action);

// Converts `base::Value` into a "flattened" user-facing string, comprising
// lines of `path.separated.by.dots: value`.
// Numbers are not localised.
// This string is not intended to be machine parseable.
// Returns nullopt if any of the following occur:
// - a binary value is encountered
// - the path exceeds `depth_limit` segments
// - the output string exceeds `output_limit` characters
ASH_EXPORT std::optional<std::string> ValueToUserFacingString(
    base::ValueView value,
    size_t depth_limit,
    size_t output_limit);

}  // namespace ash

#endif  // ASH_SCANNER_SCANNER_FEEDBACK_H_