cmd

const (
	FLAG_DIFF_FILENAME_REVISION       = "input-revision"
	FLAG_DIFF_FILENAME_REVISION_SHORT = "r"
	MSG_FLAG_INPUT_REVISION           = "input filename for the revised file to compare against the base file"
	MSG_FLAG_DIFF_COLORIZE            = "Colorize diff text output (true|false); default false"
)

const (
	ERROR_APPLICATION = 1
	ERROR_VALIDATION  = 2
)

const (
	ERR_TYPE_INVALID_JSON_MAP         = "invalid JSON map"
	ERR_TYPE_INVALID_SBOM             = "invalid SBOM"
	ERR_TYPE_SBOM_COMPONENT           = "component error"
	ERR_TYPE_SBOM_LICENSE             = "license error"
	ERR_TYPE_SBOM_COMPOSITION         = "composition error"
	ERR_TYPE_SBOM_METADATA            = "metadata error"
	ERR_TYPE_SBOM_METADATA_PROPERTY   = "metadata property error"
	ERR_TYPE_UNEXPECTED_ERROR         = "unexpected error"
	ERR_TYPE_UNSUPPORTED_OPERATION    = "unsupported operation"
	ERR_TYPE_IETF_RFC6902_TEST_FAILED = "IETF RFC6902 test operation error"
)

const (
	MSG_FORMAT_TYPE                           = "format: `%s`"
	MSG_SCHEMA_ERRORS                         = "schema errors found"
	MSG_INVALID_METADATA_PROPERTIES           = "field `metadata.properties` is missing or invalid"
	MSG_INVALID_METADATA_COMPONENT_COMPONENTS = "field `metadata.component.components` array should be empty"
	MSG_INVALID_METADATA_COMPONENT            = "field `metadata.component` is missing or invalid"
	MSG_PROPERTY_NOT_FOUND                    = "property not found"
	MSG_PROPERTY_NOT_UNIQUE                   = "check failed: property not unique"
	MSG_PROPERTY_REGEX_FAILED                 = "check failed: property regex mismatch"
	MSG_IETF_RFC6902_OPERATION_SUCCESS        = "IETF RFC6902 test operation success"
)

const (
	MSG_LICENSE_INVALID_DATA   = "invalid license data"
	MSG_LICENSE_INVALID_POLICY = "invalid license policy"
	MSG_LICENSES_NOT_FOUND     = "licenses not found"
)

const (
	MSG_QUERY_ERROR_FROM_KEY_NOT_FOUND         = "key not found in path"
	MSG_QUERY_ERROR_FROM_KEY_SLICE_DEREFERENCE = "key attempts to dereference into an array"
	MSG_QUERY_ERROR_SELECT_WILDCARD            = "wildcard cannot be used with other values"
)

const (
	SUBCOMMAND_LICENSE_LIST   = "list"
	SUBCOMMAND_LICENSE_POLICY = "policy"
)

const (
	LICENSE_LIST_NOT_APPLICABLE = "N/A"
	LICENSE_NO_ASSERTION        = "NOASSERTION"
)

const (
	FLAG_LICENSE_LIST_OUTPUT_FORMAT_HELP = "format output using the specified format type"
	FLAG_LICENSE_LIST_SUMMARY_HELP       = "summarize licenses and component references when listing in supported formats"
)

const (
	MSG_OUTPUT_NO_LICENSES_FOUND            = "no licenses found in BOM document"
	MSG_OUTPUT_NO_LICENSES_ONLY_NOASSERTION = "no valid licenses found in BOM document (only licenses marked NOASSERTION)"
)

const (
	LICENSE_FILTER_KEY_USAGE_POLICY  = "usage-policy"
	LICENSE_FILTER_KEY_LICENSE_TYPE  = "license-type"
	LICENSE_FILTER_KEY_LICENSE       = "license"
	LICENSE_FILTER_KEY_RESOURCE_NAME = "resource-name"
	LICENSE_FILTER_KEY_BOM_REF       = "bom-ref"
	LICENSE_FILTER_KEY_BOM_LOCATION  = "bom-location"
)

const (
	POLICY_FILTER_KEY_USAGE_POLICY = "usage-policy"
	POLICY_FILTER_KEY_FAMILY       = "family"
	POLICY_FILTER_KEY_SPDX_ID      = "id"
	POLICY_FILTER_KEY_NAME         = "name"
	POLICY_FILTER_KEY_OSI_APPROVED = "osi"
	POLICY_FILTER_KEY_FSF_APPROVED = "fsf"
	POLICY_FILTER_KEY_DEPRECATED   = "deprecated"
	POLICY_FILTER_KEY_REFERENCE    = "reference"
	POLICY_FILTER_KEY_ALIASES      = "aliases"
	POLICY_FILTER_KEY_ANNOTATIONS  = "annotations"
	POLICY_FILTER_KEY_NOTES        = "notes"
)

const (
	FLAG_POLICY_OUTPUT_FORMAT_HELP    = "format output using the specified type"
	FLAG_POLICY_REPORT_LINE_WRAP_HELP = "toggles the wrapping of text within report column output (default: false)"
)

const (
	// Patch operations
	IETF_RFC6902_OP_ADD     = "add"
	IETF_RFC6902_OP_REMOVE  = "remove"
	IETF_RFC6902_OP_REPLACE = "replace"
	IETF_RFC6902_OP_MOVE    = "move"
	IETF_RFC6902_OP_COPY    = "copy"
	IETF_RFC6902_OP_TEST    = "test"
)

const (
	FLAG_OUTPUT_FORMAT  = "format"
	FLAG_QUERY_SELECT   = "select"
	FLAG_QUERY_FROM     = "from"
	FLAG_QUERY_WHERE    = "where"
	FLAG_QUERY_ORDER_BY = "orderby"
)

const (
	FLAG_QUERY_OUTPUT_FORMAT_HELP = "format output using the specified type"
	FLAG_QUERY_SELECT_HELP        = "comma-separated list of JSON key names used to select fields within the object designated by the FROM flag" +
		"\n- the wildcard character `*` can be used to denote inclusion of all found key-values"
	FLAG_QUERY_FROM_HELP = "dot-separated list of JSON key names used to dereference into the JSON document" +
		"\n - if not present, the query assumes document \"root\" as the `--from` object"
	FLAG_QUERY_WHERE_HELP    = "comma-separated list of key=<regex> of clauses used to filter the SELECT result set"
	FLAG_QUERY_ORDER_BY_HELP = "key name that appears in the SELECT result set used to order the result records"
)

const (
	FLAG_REPORT_WHERE      = "where"
	FLAG_REPORT_WHERE_HELP = "comma-separated list of `key=<regex>` clauses used to filter the result set"
)

const (
	REPORT_LIST_TITLE_ROW_SEPARATOR = "-"
	REPORT_LIST_VALUE_NONE          = "none"
)

const (
	MD_COLUMN_SEPARATOR = "|"
	MD_ALIGN_LEFT       = ":--"
	MD_ALIGN_CENTER     = "-:-"
	MD_ALIGN_RIGHT      = "--:"
)

const (
	RESOURCE_FILTER_KEY_TYPE    = "type"
	RESOURCE_FILTER_KEY_NAME    = "name"
	RESOURCE_FILTER_KEY_VERSION = "version"
	RESOURCE_FILTER_KEY_BOMREF  = "bom-ref"
)

const (
	FLAG_RESOURCE_TYPE      = "type"
	FLAG_RESOURCE_TYPE_HELP = "filter output by resource type (i.e., component | service)"
)

const (
	CMD_DIFF          = "diff"
	CMD_LICENSE       = "license"
	CMD_QUERY         = "query"
	CMD_RESOURCE      = "resource"
	CMD_SCHEMA        = "schema"
	CMD_VALIDATE      = "validate"
	CMD_VERSION       = "version"
	CMD_VULNERABILITY = "vulnerability"
	CMD_STATS         = "stats"
	CMD_TRIM          = "trim"
	CMD_PATCH         = "patch"
)

const (
	CMD_USAGE_DIFF               = CMD_DIFF + " --input-file <base_file> --input-revision <revised_file> [--format json|txt] [--colorize=true|false]"
	CMD_USAGE_LICENSE_LIST       = SUBCOMMAND_LICENSE_LIST + " --input-file <input_file> [--summary] [--where key=regex[,...]] [--format json|txt|csv|md]"
	CMD_USAGE_LICENSE_POLICY     = SUBCOMMAND_LICENSE_POLICY + " [--where key=regex[,...]] [--format txt|csv|md]"
	CMD_USAGE_QUERY              = CMD_QUERY + " --input-file <input_file> [--select * | field1[,fieldN]] [--from [key1[.keyN]] [--where key=regex[,...]]"
	CMD_USAGE_RESOURCE_LIST      = CMD_RESOURCE + " --input-file <input_file> [--type component|service] [--where key=regex[,...]] [--format txt|csv|md]"
	CMD_USAGE_SCHEMA_LIST        = CMD_SCHEMA + " [--where key=regex[,...]] [--format txt|csv|md]"
	CMD_USAGE_VALIDATE           = CMD_VALIDATE + " --input-file <input_file> [--variant <variant_name>] [--format txt|json] [--force schema_file]"
	CMD_USAGE_VULNERABILITY_LIST = CMD_VULNERABILITY + " " + SUBCOMMAND_VULNERABILITY_LIST + " --input-file <input_file> [--summary] [--where key=regex[,...]] [--format json|txt|csv|md]"
	CMD_USAGE_STATS_LIST         = CMD_STATS + " --input-file <input_file> [--type component|service] [--format txt|csv|md]"
	CMD_USAGE_TRIM               = CMD_TRIM + " --input-file <input_file>  --output-file <output_file>"
	CMD_USAGE_PATCH              = CMD_PATCH + " --input-file <input_file> --patch-file <patch_file> --output-file <output_file>"
)

const (
	FLAG_CONFIG_SCHEMA            = "config-schema"
	FLAG_CONFIG_LICENSE_POLICY    = "config-license"
	FLAG_CONFIG_CUSTOM_VALIDATION = "config-validation"
	FLAG_TRACE                    = "trace"
	FLAG_TRACE_SHORT              = "t"
	FLAG_DEBUG                    = "debug"
	FLAG_DEBUG_SHORT              = "d"
	FLAG_FILENAME_INPUT           = "input-file"
	FLAG_FILENAME_INPUT_SHORT     = "i"
	FLAG_FILENAME_OUTPUT          = "output-file"
	FLAG_FILENAME_OUTPUT_SHORT    = "o"
	FLAG_QUIET_MODE               = "quiet"
	FLAG_QUIET_MODE_SHORT         = "q"
	FLAG_OUTPUT_INDENT            = "indent"
	FLAG_LOG_OUTPUT_INDENT        = "log-indent"
	FLAG_FILE_OUTPUT_FORMAT       = "format"
	FLAG_COLORIZE_OUTPUT          = "colorize"
)

const (
	MSG_APP_NAME            = "Bill-of-Materials (BOM) utility."
	MSG_APP_DESCRIPTION     = "This utility serves as centralized command-line interface for various Bill-of-Materials (BOM) helper utilities."
	MSG_FLAG_TRACE          = "enable trace logging"
	MSG_FLAG_DEBUG          = "enable debug logging"
	MSG_FLAG_INPUT          = "input filename (e.g., \"path/sbom.json\")"
	MSG_FLAG_OUTPUT         = "output filename"
	MSG_FLAG_OUTPUT_FORMAT  = "format output using the specified type"
	MSG_FLAG_LOG_QUIET      = "enable quiet logging mode (removes all informational messages from console output); overrides other logging commands"
	MSG_FLAG_LOG_INDENT     = "enable log indentation of functional callstack"
	MSG_FLAG_CONFIG_SCHEMA  = "provide custom application schema configuration file (i.e., overrides default `config.json`)"
	MSG_FLAG_CONFIG_LICENSE = "provide custom application license policy configuration file (i.e., overrides default `license.json`)"
	MSG_FLAG_OUTPUT_INDENT  = "number of space characters used to indent JSON formatted output"
)

const (
	MSG_SUPPORTED_OUTPUT_FORMATS_HELP         = "\n- Supported formats: "
	MSG_SUPPORTED_OUTPUT_FORMATS_SUMMARY_HELP = "\n- Supported formats using the --summary flag: "
)

const (
	DEFAULT_SCHEMA_CONFIG            = "config.json"
	DEFAULT_CUSTOM_VALIDATION_CONFIG = "custom.json"
	DEFAULT_LICENSE_POLICY_CONFIG    = "license.json"
)

const (
	FORMAT_DEFAULT  = ""
	FORMAT_TEXT     = "txt"
	FORMAT_JSON     = "json"
	FORMAT_CSV      = "csv"
	FORMAT_MARKDOWN = "md"
	FORMAT_ANY      = "<any>" // Used for test errors
)

const (
	SCHEMA_DATA_KEY_KEY_NAME    = "name"    // summary
	SCHEMA_DATA_KEY_KEY_FORMAT  = "format"  // summary
	SCHEMA_DATA_KEY_KEY_VERSION = "version" // summary
	SCHEMA_DATA_KEY_KEY_VARIANT = "variant" // summary
	SCHEMA_DATA_KEY_KEY_FILE    = "file"    // summary
	SCHEMA_DATA_KEY_KEY_SOURCE  = "url"     // summary
)

const (
	FLAG_TRIM_FROM_PATHS = "from"
	FLAG_TRIM_MAP_KEYS   = "keys"
)

const (
	MSG_FLAG_TRIM_FROM_PATHS = "comma-separated list of dot-separated JSON document paths used to scope where trim is applied" +
		"\n - if not present, the default `--from` path is the document \"root\""
	MSG_FLAG_TRIM_KEYS = "JSON map keys to trim (delete) (e.g., \"key1,key2,...,keyN\")"
)

const (
	TRIM_KEYS_SEP            = ","
	TRIM_PATH_SEP            = "."
	TRIM_PATHS_SEP           = ","
	TRIM_FROM_TOKEN_WILDCARD = "*"
)

const (
	VALID   = true
	INVALID = false
)

const (
	FLAG_VALIDATE_SCHEMA_FORCE     = "force"
	FLAG_VALIDATE_SCHEMA_VARIANT   = "variant"
	FLAG_VALIDATE_CUSTOM           = "custom" // TODO: document when no longer experimental
	FLAG_VALIDATE_ERR_LIMIT        = "error-limit"
	FLAG_VALIDATE_ERR_VALUE        = "error-value"
	MSG_VALIDATE_SCHEMA_FORCE      = "force specified schema file for validation; overrides inferred schema"
	MSG_VALIDATE_SCHEMA_VARIANT    = "select named schema variant (e.g., \"strict\"); variant must be declared in configuration file (i.e., \"config.json\")"
	MSG_VALIDATE_FLAG_CUSTOM       = "perform custom validation using custom configuration settings (i.e., \"custom.json\")"
	MSG_VALIDATE_FLAG_ERR_COLORIZE = "Colorize formatted error output (true|false); default true"
	MSG_VALIDATE_FLAG_ERR_LIMIT    = "Limit number of errors output to specified (integer) (default 10)"
	MSG_VALIDATE_FLAG_ERR_FORMAT   = "format error results using the specified format type"
	MSG_VALIDATE_FLAG_ERR_VALUE    = "include details of failing value in error results (bool) (default: true)"
)

const (
	DEFAULT_MAX_ERROR_LIMIT         = 10
	DEFAULT_MAX_ERR_DESCRIPTION_LEN = 128
)

const (
	ERROR_DETAIL_KEY_DATA_TYPE         = "type"
	ERROR_DETAIL_KEY_FIELD             = "field"
	ERROR_DETAIL_KEY_CONTEXT           = "context"
	ERROR_DETAIL_KEY_VALUE             = "value"
	ERROR_DETAIL_KEY_VALUE_TYPE_ARRAY  = "array"
	ERROR_DETAIL_KEY_VALUE_INDEX       = "index"
	ERROR_DETAIL_KEY_VALUE_ITEM        = "item"
	ERROR_DETAIL_KEY_VALUE_DESCRIPTION = "description"
	ERROR_DETAIL_ARRAY_ITEM_INDEX_I    = "i"
	ERROR_DETAIL_ARRAY_ITEM_INDEX_J    = "j"
	ERROR_DETAIL_CONTEXT_EMPTY         = ""
)

const (
	ERROR_DETAIL_JSON_DEFAULT_PREFIX    = "    "
	ERROR_DETAIL_JSON_DEFAULT_INDENT    = "    "
	ERROR_DETAIL_JSON_CONTEXT_DELIMITER = "."
	ERROR_DETAIL_JSON_NEWLINE_INDENT    = "\n" + ERROR_DETAIL_JSON_DEFAULT_PREFIX
)

const (
	JSON_ARRAY_START    = "[\n"
	JSON_ARRAY_ITEM_SEP = ",\n"
	JSON_ARRAY_END      = "\n]\n"
)

const (
	MSG_INFO_FORMATTING_ERROR_RESULTS = "Formatting error results (`%s` format)..."
	MSG_INFO_SCHEMA_ERRORS_DETECTED   = "(%d) schema errors detected."
	MSG_INFO_TOO_MANY_ERRORS          = "Too many errors. Showing (%v/%v) errors."
	MSG_ERROR_FORMATTING_ERROR        = "formatting error: %s"
	MSG_WARN_INVALID_FORMAT           = "invalid format. error results not supported for `%s` format; defaulting to `%s` format..."
)

const (
	VULN_DATA_KEY_ID                     = "id"                     // summary
	VULN_DATA_KEY_BOM_REF                = "bom-ref"                // full (optional, internal reference)
	VULN_DATA_KEY_CWES                   = "cwe-ids"                // full (Common Weakness Enumeration (CWE))
	VULN_DATA_KEY_CVSS_SEVERITY          = "cvss-severity"          // summary (CVSS Severity, V3.1 ot v2.0)
	VULN_DATA_KEY_SOURCE_NAME            = "source-name"            // summary
	VULN_DATA_KEY_SOURCE_URL             = "source-url"             // full
	VULN_DATA_KEY_PUBLISHED              = "published"              // summary
	VULN_DATA_KEY_UPDATED                = "updated"                // full
	VULN_DATA_KEY_CREATED                = "created"                // full
	VULN_DATA_KEY_REJECTED               = "rejected"               // full
	VULN_DATA_KEY_ANALYSIS_STATE         = "analysis-state"         // full
	VULN_DATA_KEY_ANALYSIS_JUSTIFICATION = "analysis-justification" // full
	VULN_DATA_KEY_DESC                   = "description"            // summary
)

const (
	FLAG_VULNERABILITY_OUTPUT_FORMAT_HELP = "format vulnerability output"
	FLAG_VULN_SUMMARY_HELP                = "summarize vulnerability information when listing in supported formats"
)

const DEFAULT_COLUMN_TRUNCATE_LENGTH = -1

const (
	DEFAULT_OUTPUT_INDENT_LENGTH = 4
)

const (
	ERR_FORMAT_DETAIL_SEP = ": "
)

const (
	ERR_PATCH_REPLACE_PATH_EXISTS = "invalid path. Path does not exist to replace value"
)

const (
	FLAG_DIFF_OUTPUT_FORMAT_HELP = "format output using the specified type"
)

const (
	FLAG_LICENSE_POLICY_LIST_SUMMARY_HELP = "summarize licenses and policies when listing in supported formats"
)

const (
	FLAG_LICENSE_SUMMARY = "summary"
)

const (
	FLAG_PATCH_FILE = "patch-file"
)

const (
	FLAG_POLICY_REPORT_LINE_WRAP = "wrap"
)

const (
	FLAG_RESOURCE_OUTPUT_FORMAT_HELP = "format output using the specified type"
)

const (
	FLAG_SCHEMA_OUTPUT_FORMAT_HELP = "format output using the specified type"
)

const (
	FLAG_VULN_SUMMARY = "summary"
)

const (
	INPUT_TYPE_STDIN = "-"
)

const (
	MSG_OUTPUT_NO_POLICIES_FOUND = "no license policies found in BOM document"
)

const (
	MSG_OUTPUT_NO_RESOURCES_FOUND = "[WARN] no matching resources found for query"
)

const (
	MSG_OUTPUT_NO_SCHEMAS_FOUND = "[WARN] no schemas found in configuration (i.e., \"config.json\")"
)

const (
	MSG_OUTPUT_NO_VULNERABILITIES_FOUND = "[WARN] no matching vulnerabilities found for query"
)

const (
	MSG_PATCH_FILE = "patch filename"
)

const (
	PROTOCOL_PREFIX_FILE = "file://"
)

const REPORT_REPLACE_LINE_FEEDS_TRUE = true

const REPORT_SUMMARY_DATA_TRUE = true

const (
	RFC6901_END_OF_ARRAY = "-"
)

const (
	SUBCOMMAND_POLICY_LIST = "list"
)

const (
	SUBCOMMAND_RESOURCE_LIST = "list"
)

const (
	SUBCOMMAND_SCHEMA_LIST = "list"
)

const (
	SUBCOMMAND_VULNERABILITY_LIST = "list"
)

const VULN_TRUNCATE_DESC_LEN = 32