@invisra/printspec

@invisra/printspec

TypeScript package for printspec JSON Schemas, offline validation, BOM helpers, browser form metadata helpers, CLI commands, deterministic bundle export, and starter OpenSCAD/CadQuery source generation.

Status: npm package v0.1.1 / schema v0.1.0 experimental. Version 0.1.1 is a packaging-only patch that includes built dist/ artifacts; schemas and printspecVersion remain 0.1.0.

Installation

# From a repository checkout
npm install
npm --workspace @invisra/printspec run build

# Once published
npm install @invisra/printspec

ESM-only API usage

This package is ESM-only ("type": "module").

import { validatePrintSpec, generateOpenScad } from "@invisra/printspec";

const spec = {
  printspecVersion: "0.1.0",
  units: "mm",
  part: {
    type: "round_spacer",
    label: "Smoke spacer",
    parameters: { outerDiameter: 12, innerDiameter: 4, height: 8 }
  }
};

const result = validatePrintSpec(spec);
console.log(result.valid, result.errors);

const generated = generateOpenScad(spec);
if (generated.supported) console.log(generated.code);

CLI usage

printspec --version
printspec validate examples/part-families/rounded-rectangular-plate.basic.json
printspec bom examples/projects/simple-enclosure-project.json --format markdown
printspec form-metadata rounded_rectangular_plate
printspec list-part-families
printspec to-openscad examples/part-families/round-spacer.basic.json --output round-spacer.scad
printspec to-cadquery examples/part-families/electronics-standoff.m3.json --output standoff.py
printspec bundle examples/part-families/rounded-rectangular-plate.basic.json --output bundle --overwrite

Bundle example

import { createBundle, writeBundleToDirectory } from "@invisra/printspec";

const bundle = createBundle(spec, { includePartCad: true });
writeBundleToDirectory(bundle, "bundle", { overwrite: true });

Package exports and bundled schemas

The package exports the main ESM API from @invisra/printspec and package schema files through @invisra/printspec/schemas/*. Published npm packages must include built TypeScript artifacts under dist/ (dist/index.js, dist/index.d.ts, and dist/cli.js) and schema files under schemas/.

Validation resolves bundled schemas offline. It does not fetch hosted schema URLs during normal validation.

Hosted schema note

Hosted schemas at https://schemas.invisra.ai/printspec/0.1.0/ are public references for documentation and external tools. They are not required for package validation.

Safety note

Generated OpenSCAD and CadQuery source is a starter artifact for review. This package does not export STL/STEP/3MF files and does not run CAD runtimes, slicers, supplier APIs, or purchasing automation. Do not use generated designs without appropriate engineering review.