@meticulous-home/espresso-profile-converter

A TypeScript/JavaScript library for:

• validating simplified JSON against the schema maintained in ../espresso-profile-schema
• expanding $... variables the same way the current backend does
• converting simplified JSON into the node JSON currently produced by profile_converter/

Installation

npm install @meticulous-home/espresso-profile-converter

Usage

import {
  convertSimplifiedToNodeProfile,
  processVariables,
  validateSimplifiedProfile,
} from "@meticulous-home/espresso-profile-converter";

const validation = validateSimplifiedProfile(profile);

if (!validation.valid) {
  throw new Error(validation.errors.join("\n"));
}

const expanded = processVariables(profile);

const nodeProfile = convertSimplifiedToNodeProfile(expanded, {
  clickToPurge: true,
  endNodeHead: 1000,
  initNodeTail: 7000,
  allowStageSkipping: false,
  partialRetraction: 45,
  maxPistonPosition: 75,
  validate: false,
  processVariables: false,
});

CLI

After building the package, you can convert a simplified profile from the command line:

npm run build
npm run convert -- ./test/fixtures/simplified-json-example.json

To write the result to a file instead of stdout:

npm run convert -- ./test/fixtures/simplified-json-example.json \
  --output ./node-profile.json

If the package is installed globally or exposed through npx, the binary name is:

espresso-profile-convert ./profile.json --output ./node-profile.json

API

• validateSimplifiedProfile(profile): returns { valid, errors }
• assertValidSimplifiedProfile(profile): throws SchemaValidationError
• processVariables(profile): mirrors ProfilePreprocessor.processVariables(...)
• convertSimplifiedStagesToNodeStages(profile, options?): converts only the dynamic stages
• convertSimplifiedToNodeProfile(profile, options?): builds the full { name, stages } node profile

Conversion Options

• clickToPurge: default true
• endNodeHead: default 1000
• initNodeTail: default 7000
• allowStageSkipping: default false
• partialRetraction: default 45
• maxPistonPosition: default 75
• validate: default true
• processVariables: default true

clickToStart is accepted by the interface for compatibility with the current Python signature, but it does not affect the output today because it is not used in profile_converter.py either.

Schema Sync

The package includes a copy of the schema so it can be published to npm independently. To sync it again from the sibling repository:

npm run sync:schema

This copies ../../espresso-profile-schema/schema.json into src/schema/simplified-profile.schema.json.