# profile-evaluator

**Repository Path**: mirrors_adobe/profile-evaluator

## Basic Information

- **Project Name**: profile-evaluator
- **Description**: Node.js application for processing a JPEG Trust Indicator Set and a JPEG Trust Profile as per ISO 21617-1.
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-07-22
- **Last Updated**: 2026-01-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# JPEG Trust Evaluator

This project is a command line tool that evaluates a JSON file containing a Trust Indicator Set according to the (YAML-based) Trust Profile, based on the details from the JPEG Trust (ISO 21617-1:2025) standard.

This tool also serves to validate forthcoming work in the 2nd Edition of JPEG Trust Part 1 as well as JPEG Trust Part 2 (ISO 21617-2).

## Table of Contents

- [Installation](#installation)
- [Usage](#usage)
- [Examples](#examples)
- [Contributing](#contributing)
- [License](#license)

## Installation

1. Clone the repository:
   ```
   git clone https://github.com/adobe/profile-evaluator.git
   ```

2. Navigate to the project directory:
   ```
   cd profile-evaluator
   ```

3. Install the dependencies:
   ```
   npm install
   ```

## Usage

To run the tool, use the following command:

```
node src/index.js [options] <jsonFile>
```

### Required Arguments
- `<jsonFile>` - Path to the JSON file containing Trust Indicator Set to evaluate

### Required Options
- `-p, --profile <path>` - Path to the Trust Profile file (YAML format)

**OR**

- `-e, --eval <expression>` - JSON formula expression to evaluate against the data (cannot be used with --profile)

### Optional Options
- `-o, --output <directory>` - Output directory for reports (if not specified, results are printed to console)
- `-y, --yaml` - Output report in YAML format (default)
- `-j, --json` - Output report in YAML format
- `--html <path>` - Path to HTML template file for generating HTML reports
- `-h, --help` - Display help information
- `-V, --version` - Display version number

## Examples

1. **Basic evaluation** (output to console):
   ```
   node src/index.js -p testfiles/camera_profile.yml testfiles/camera_indicators.json
   ```

2. **Generate YAML report** in output directory:
   ```
   node src/index.js -p testfiles/genai_profile.yml -o output testfiles/genai_indicators.json
   ```

3. **Generate JSON report**:
   ```
   node src/index.js -p testfiles/no_manifests_profile.yml -o output --json testfiles/no_manifests_indicators.json
   ```

4. **Generate HTML report** using a template:
   ```
   node src/index.js -p testfiles/camera_profile.yml -o output --html testfiles/report_template.html testfiles/camera_indicators.json
   ```

5. **Evaluate a simple expression** against Trust Indicator Set data:
   ```
   node src/index.js --eval "declaration.'claim.v2'.alg" testfiles/camera_indicators.json
   ```

6. **Check if a property exists**:
   ```
   node src/index.js --eval "has(declaration.assertions)" testfiles/camera_indicators.json
   ```

## Evaluation Mode

The `--eval` option allows you to run JSON formula expressions directly against Trust Indicator Set data without requiring a Trust Profile. This is useful for:

- **Quick data exploration**: Extract specific values from Trust Indicator Sets
- **Property validation**: Check if certain fields exist in the data
- **Data transformation**: Apply expressions to compute derived values
- **Debugging**: Test expressions before including them in Trust Profiles

### Expression Syntax

The tool supports JSON formula expressions with the following features:

- **Property access**: Use dot notation (e.g., `data.field`)
- **Nested properties**: Use quotes for special characters (e.g., `"claim.v2"`)
- **Array access**: Use bracket notation (e.g., `array[0]`)
- **Functions**: Built-in functions like `has()`, `length()`, etc.
- **Operators**: Standard comparison and logical operators

### Evaluation Examples

```bash
# Extract a simple property
node src/index.js --eval "declaration" testfiles/camera_indicators.json

# Access nested properties with special characters
node src/index.js --eval "declaration.'claim.v2'.alg" testfiles/camera_indicators.json

# Check if a property exists
node src/index.js --eval "has(declaration.assertions)" testfiles/camera_indicators.json

# Get array length
node src/index.js --eval "length(declaration.assertions)" testfiles/camera_indicators.json
```

**Note**: The `--eval` and `--profile` options are mutually exclusive - you cannot use both in the same command.

## Development

### Scripts

```bash
# Run the CLI
npm start

# Run tests
npm test

# Run tests with coverage
npm run test:coverage

# Run tests in watch mode
npm run test:watch

# Lint code
npm run lint

# Fix linting issues
npm run lint:fix
```

### Testing

The project includes comprehensive tests using Jest:

- **Unit Tests**: Test individual features and functions
- **Integration Tests**: Test the complete CLI workflow
- **Error Handling Tests**: Verify graceful error handling

```bash
# Run all tests
npm test

# Run tests with coverage report
npm run test:coverage

# Run tests in watch mode for development
npm run test:watch
```

### Code Quality

The project uses ESLint for code quality and consistency:

```bash
# Check for linting issues
npm run lint

# Automatically fix linting issues
npm run lint:fix
```

### ESLint Configuration

The project uses modern ESLint configuration with the following features:

- **Modern JavaScript**: ES2020 support with async/await
- **Node.js Environment**: Configured for Node.js development
- **Strict Rules**: Enforces consistent code style and best practices
- **Jest Support**: Configured for Jest testing environment


## Contributing

Contributions are welcome! Please open an issue or submit a pull request for any enhancements or bug fixes.

### Submitting a Pull Request

1. Fork the repository
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3. Make your changes
4. Run tests (`npm test`)
5. Run linting (`npm run lint`)
6. Commit your changes (`git commit -m 'Add amazing feature'`)
7. Push to the branch (`git push origin feature/amazing-feature`)
8. Open a Pull Request


## License

This project is licensed under the Apache 2.0 License. See the LICENSE file for more details.

## Changelog

### v1.1
- Changed default output format to YAML
- Added `--eval` option for evaluating JSON formula expressions directly
  (and associated tests!)
- Improved error handling for missing profile or JSON file
- Started work on 21617-2 support

### v1.0.0
- Initial release
- Comprehensive test suite
- ESLint integration
- Jest testing framework
- Pretty printing support
- Error handling and validation