# contentauth/c2pa-test-image-service architecture

> Architecture diagram of the GitHub repository contentauth/c2pa-test-image-service, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/contentauth/c2pa-test-image-service
- Repository: https://github.com/contentauth/c2pa-test-image-service

## Overview

##### Project type and purpose
- This is a backend Node.js HTTP microservice (“c2pa-test-image-service”) written in TypeScript.
- It uses Express to serve GET requests, Sharp to generate image buffers, and c2pa-node to embed C2PA metadata.
- It exposes an NPM CLI entrypoint (`npx c2pa-test-image-service`) and reads a user-provided config file defining “fixtures” (image + manifest + ingredients + assertions).

##### File structure
Top-level:
- package.json, pnpm-lock.yaml, tsconfig.json → build & dependency config
- README.md, LICENSE, .gitignore
src/:
- cli.ts         → parses CLI flags, locates config file, invokes `main`
- config.ts      → loads & validates user config (port, fixtures)
- index.ts       → exports SDK/public API (`createAsset`, `createFixtureStore`)
- main.ts        → instantiates Express app, applies middleware, mounts routes, starts listening
- sdk.ts         → implements high-level asset creation & fixture-store logic
- fixtureBuilder.ts → transforms SDK data structures into raw fixture objects consumed at runtime
- createdSignedAssetBuffer.ts → core pipeline: Sharp image gen → c2pa-node signing → JPEG buffer

##### README for insights
- Confirms Express + c2pa-node + Sharp stack
- Outlines flow: request → choose fixture by name → generate & return signed image buffer

##### Main components & interactions
a. Components
1. CLI Entrypoint (cli.ts)
2. Configuration Loader (config.ts + user’s config file)
3. Express Server (main.ts + index.ts route registration)
4. Fixture Store (in-memory object from fixtureBuilder.ts)
5. SDK / Fixture Builder API (sdk.ts + fixtureBuilder.ts)
6. Image Processing & Signing pipeline (createdSignedAssetBuffer.ts)
7. External Libraries:
- Sharp (image creation)
- c2pa-node (metadata embedding)
8. HTTP Client (browser or test harness)

b. Relationships & data flow
- CLI → loads config → passes to `main`
- main → instantiates Express app on configured port
- HTTP GET `/[:fixtureName]` → Express router → handler
- Handler → queries Fixture Store for fixture descriptor
- Fixture descriptor → passed to Asset Builder pipeline
- Pipeline: generate raw image via Sharp → embed C2PA data via c2pa-node → produce JPEG buffer
- Buffer → returned as HTTP response body

c. Architectural patterns & principles
- Modular separation: CLI, config, server, SDK, pipeline
- Single responsibility per module
- In-memory “fixture store” acts like a lightweight configuration-driven data source
- Functional pipeline for image + metadata generation

d. Key technologies & libraries
- Node.js + TypeScript
- Express (HTTP server)
- Sharp (image buffer generation)
- c2pa-node (C2PA metadata signing)
- CLI via NPM `bin` entrypoint
- Config loading & validation

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Project Config & Dependencies"
        pkg["package.json"]:::external
        ts["tsconfig.json"]:::external
        lock["pnpm-lock.yaml"]:::external
        readme["README.md"]:::external
        lic["LICENSE"]:::external
        gitignore[".gitignore"]:::external
    end

    subgraph "External Dependencies"
        Sharp["Sharp"]:::lib
        C2PA["c2pa-node"]:::lib
        ConfigFile["User Config File"]:::external
    end

    subgraph "Startup"
        CLI["CLI Entrypoint"]:::core
        ConfigLoader["Configuration Loader"]:::core
        ExpressServer["Express Server"]:::core
    end

    subgraph "Core Modules"
        index["Public API / Route Mounting"]:::core
        SDK["SDK / Fixture Logic"]:::core
        FixtureStore["Fixture Store Builder"]:::core
        AssetPipeline["Image Processing & Signing Pipeline"]:::core
    end

    Client["HTTP Client"]:::external

    pkg -->|"provides config"| ConfigLoader
    ts -->|"TS setup"| CLI
    lock -->|"lock deps"| CLI
    readme -->|"docs"| CLI
    lic -->|"license info"| CLI
    gitignore -->|"ignore patterns"| CLI
    ConfigFile -->|"user config"| ConfigLoader

    CLI -->|"load config"| ConfigLoader
    ConfigLoader -->|"pass config"| ExpressServer
    ExpressServer -->|"mount routes"| index
    index -->|"use SDK"| SDK
    SDK -->|"build store"| FixtureStore

    Client -->|"GET /:fixtureName"| ExpressServer
    ExpressServer -->|"route to handler"| FixtureStore
    FixtureStore -->|"fixture descriptor"| AssetPipeline
    AssetPipeline -->|"generate image buffer"| Sharp
    AssetPipeline -->|"embed C2PA metadata"| C2PA
    AssetPipeline -->|"JPEG buffer"| ExpressServer
    ExpressServer -->|"HTTP response"| Client

    click pkg "https://github.com/contentauth/c2pa-test-image-service/blob/main/package.json"
    click ts "https://github.com/contentauth/c2pa-test-image-service/blob/main/tsconfig.json"
    click lock "https://github.com/contentauth/c2pa-test-image-service/blob/main/pnpm-lock.yaml"
    click readme "https://github.com/contentauth/c2pa-test-image-service/blob/main/README.md"
    click lic "https://github.com/contentauth/c2pa-test-image-service/tree/main/LICENSE"
    click gitignore "https://github.com/contentauth/c2pa-test-image-service/blob/main/.gitignore"
    click CLI "https://github.com/contentauth/c2pa-test-image-service/blob/main/src/cli.ts"
    click ConfigLoader "https://github.com/contentauth/c2pa-test-image-service/blob/main/src/config.ts"
    click ExpressServer "https://github.com/contentauth/c2pa-test-image-service/blob/main/src/main.ts"
    click index "https://github.com/contentauth/c2pa-test-image-service/blob/main/src/index.ts"
    click SDK "https://github.com/contentauth/c2pa-test-image-service/blob/main/src/sdk.ts"
    click FixtureStore "https://github.com/contentauth/c2pa-test-image-service/blob/main/src/fixtureBuilder.ts"
    click AssetPipeline "https://github.com/contentauth/c2pa-test-image-service/blob/main/src/createdSignedAssetBuffer.ts"

    classDef core fill:#ADEBFF,stroke:#333,stroke-width:1px
    classDef lib fill:#FCE6A4,stroke:#333,stroke-width:1px
    classDef external fill:#E8E8E8,stroke:#333,stroke-width:1px
```
