@invisra/printspec 0.1.2 → 0.1.4

package/dist/browser.d.ts

@@ -0,0 +1,7 @@
+export { validatePrintSpec, validatePartFamilySpec, validateComposablePartSpec, validateProjectSpec, } from './validate.browser.js';
+export { normalizePrintSpec } from './normalize.js';
+export { extractBom, bomToMarkdown, bomToCsv, bomToSupplierOrderList, } from './bom.js';
+export { generateOpenScad } from './generators/openscad.js';
+export { generateCadQuery } from './generators/cadquery.js';
+export { createBundle } from './bundle.browser.js';
+export { getPartFamilyFormMetadata, listPartFamilies } from './forms.browser.js';

package/dist/browser.js

@@ -0,0 +1,7 @@
+export { validatePrintSpec, validatePartFamilySpec, validateComposablePartSpec, validateProjectSpec, } from './validate.browser.js';
+export { normalizePrintSpec } from './normalize.js';
+export { extractBom, bomToMarkdown, bomToCsv, bomToSupplierOrderList, } from './bom.js';
+export { generateOpenScad } from './generators/openscad.js';
+export { generateCadQuery } from './generators/cadquery.js';
+export { createBundle } from './bundle.browser.js';
+export { getPartFamilyFormMetadata, listPartFamilies } from './forms.browser.js';

package/dist/bundle.browser.d.ts

@@ -0,0 +1,3 @@
+export type { BundleFile, BundleWarning, BundleResult, BundleOptions } from './bundle.core.js';
+import type { BundleResult, BundleOptions } from './bundle.core.js';
+export declare function createBundle(input: unknown, options?: BundleOptions): BundleResult;

package/dist/bundle.browser.js

@@ -0,0 +1,5 @@
+import { validatePrintSpec } from './validate.browser.js';
+import { createBundleWithValidator } from './bundle.core.js';
+export function createBundle(input, options = {}) {
+    return createBundleWithValidator(validatePrintSpec, input, options);
+}

package/dist/bundle.core.d.ts

@@ -0,0 +1,27 @@
+import type { ValidationResult } from './types.js';
+export type BundleFile = {
+    path: string;
+    content: string;
+    mediaType: string;
+};
+export type BundleWarning = {
+    path?: string;
+    message: string;
+};
+export type BundleResult = {
+    supported: boolean;
+    files: BundleFile[];
+    warnings: BundleWarning[];
+    message?: string;
+};
+export type BundleOptions = {
+    includeOpenScad?: boolean;
+    includeCadQuery?: boolean;
+    includeBom?: boolean;
+    includePartCad?: boolean;
+    prettyJson?: boolean;
+};
+export type WriteBundleOptions = {
+    overwrite?: boolean;
+};
+export declare function createBundleWithValidator(validatePrintSpec: (spec: unknown) => ValidationResult, input: unknown, options?: BundleOptions): BundleResult;

package/dist/bundle.core.js

@@ -0,0 +1,81 @@
+import { normalizePrintSpec } from './normalize.js';
+import { generateOpenScad } from './generators/openscad.js';
+import { generateCadQuery } from './generators/cadquery.js';
+import { extractBom, bomToMarkdown, bomToCsv, bomToSupplierOrderList } from './bom.js';
+const VERSION = '0.1.0';
+const jsonMedia = 'application/json';
+function j(spec, pretty) { return JSON.stringify(spec, null, pretty ? 2 : 0) + '\n'; }
+function add(files, path, content, mediaType, role) { files.push({ path, content, mediaType, role }); }
+function warn(warnings, message, path) { warnings.push(path ? { path, message } : { message }); }
+function safePartId(id) { return id.replace(/[^A-Za-z0-9._-]/g, '-'); }
+function bomFiles(files, base, bom) { if (!bom.length)
+    return; add(files, `${base}bom.md`, bomToMarkdown(bom) + '\n', 'text/markdown', 'bom-markdown'); add(files, `${base}bom.csv`, bomToCsv(bom) + '\n', 'text/csv', 'bom-csv'); add(files, `${base}supplier-order-list.txt`, bomToSupplierOrderList(bom) + '\n', 'text/plain', 'supplier-order-list'); }
+function cadForPart(spec, base, files, warnings, opts) { if (opts.includeOpenScad) {
+    const g = generateOpenScad(spec);
+    if (g.supported) {
+        add(files, `${base}cad/model.scad`, g.code, 'text/plain', 'openscad-source');
+        for (const m of g.warnings ?? [])
+            warn(warnings, m, `${base}cad/model.scad`);
+    }
+    else
+        warn(warnings, g.message ?? 'OpenSCAD generator unsupported', `${base}cad/model.scad`);
+} if (opts.includeCadQuery) {
+    const g = generateCadQuery(spec);
+    if (g.supported) {
+        add(files, `${base}cad/model.py`, g.code, 'text/x-python', 'cadquery-source');
+        for (const m of g.warnings ?? [])
+            warn(warnings, m, `${base}cad/model.py`);
+    }
+    else
+        warn(warnings, g.message ?? 'CadQuery generator unsupported', `${base}cad/model.py`);
+} }
+function readme(kind, spec, files, warnings, bomCount) { const lines = []; lines.push(`# ${kind === 'project' ? (spec.project?.label ?? 'printspec project') : (spec.part?.label ?? 'printspec part')}`, ''); if (kind === 'part')
+    lines.push(`Part type: ${spec.part?.type ?? 'unknown'}`);
+else {
+    if (spec.project?.description)
+        lines.push(spec.project.description, '');
+    lines.push('## Parts', ...(spec.project?.parts ?? []).map((p) => `- ${p.id}: ${p.label ?? p.id} (quantity ${p.quantity ?? 1})`), '');
+} lines.push(`printspec version: ${spec.printspecVersion ?? VERSION}`, '', '## Generated files', ...files.map(f => `- ${f.path} (${f.role})`), ''); lines.push('## BOM', bomCount ? `${bomCount} BOM item(s) included.` : 'No hardware/BOM items were found.', ''); lines.push('## Warnings', ...(warnings.length ? warnings.map(w => `- ${w.path ? `${w.path}: ` : ''}${w.message}`) : ['- None']), ''); lines.push('Generated CAD source should be reviewed before manufacturing.'); return lines.join('\n') + '\n'; }
+function partcad(spec, files) { const cq = files.filter(f => f.role === 'cadquery-source').sort((a, b) => a.path < b.path ? -1 : a.path > b.path ? 1 : 0); const name = spec.project?.partcad?.packageName ?? 'printspec-project'; const lines = ['package:', `  name: ${name}`, `  version: ${spec.project?.partcad?.packageVersion ?? VERSION}`, '  description: Experimental compatibility stub generated from printspec.', '', 'parts:']; for (const f of cq) {
+    const m = f.path.match(/^parts\/([^/]+)\//);
+    lines.push(`  - name: ${m?.[1] ?? 'model'}`, '    type: cadquery', `    path: ${f.path}`);
+} if (!cq.length)
+    lines.push('  []'); return lines.join('\n') + '\n'; }
+function manifest(kind, files, warnings, spec) { const entries = files.map(f => ({ path: f.path, mediaType: f.mediaType, role: f.role })).sort((a, b) => a.path < b.path ? -1 : a.path > b.path ? 1 : 0); entries.push({ path: 'bundle-manifest.json', mediaType: jsonMedia, role: 'bundle-manifest' }); entries.sort((a, b) => a.path < b.path ? -1 : a.path > b.path ? 1 : 0); return j({ bundleVersion: VERSION, createdBy: 'printspec', printspecVersion: spec.printspecVersion ?? VERSION, kind, files: entries, warnings }, true); }
+export function createBundleWithValidator(validatePrintSpec, input, options = {}) {
+    const r = validatePrintSpec(input);
+    if (!r.valid)
+        return { supported: false, files: [], warnings: [], message: `Validation failed: ${r.errors.slice(0, 3).join('; ')}` };
+    const spec = normalizePrintSpec(input);
+    const opts = { includeOpenScad: options.includeOpenScad !== false, includeCadQuery: options.includeCadQuery !== false, includeBom: options.includeBom !== false, includePartCad: options.includePartCad === true, prettyJson: options.prettyJson !== false };
+    const files = [];
+    const warnings = [];
+    const kind = spec.project ? 'project' : 'part';
+    add(files, 'printspec.json', j(spec, opts.prettyJson), jsonMedia, 'source-spec');
+    if (kind === 'part') {
+        cadForPart(spec, '', files, warnings, opts);
+        if (opts.includeBom)
+            bomFiles(files, 'bom/', extractBom(spec));
+    }
+    else {
+        for (const p of spec.project.parts ?? []) {
+            const id = safePartId(p.id);
+            if (p.spec) {
+                const ps = normalizePrintSpec(p.spec);
+                add(files, `parts/${id}/printspec.json`, j(ps, opts.prettyJson), jsonMedia, 'part-source-spec');
+                cadForPart(ps, `parts/${id}/`, files, warnings, opts);
+            }
+            else if (p.specPath)
+                warn(warnings, `External specPath references are not bundled yet: ${p.specPath}`, `parts/${id}/printspec.json`);
+        }
+        if (opts.includeBom)
+            bomFiles(files, 'bom/', extractBom(spec));
+        if (opts.includePartCad)
+            add(files, 'partcad.yaml', partcad(spec, files), 'text/yaml', 'partcad-stub');
+    }
+    const bomCount = extractBom(spec).length;
+    add(files, 'README.md', readme(kind, spec, files, warnings, bomCount), 'text/markdown', 'readme');
+    add(files, 'bundle-manifest.json', manifest(kind, files, warnings, spec), jsonMedia, 'bundle-manifest');
+    files.sort((a, b) => a.path < b.path ? -1 : a.path > b.path ? 1 : 0);
+    return { supported: true, files: files.map(({ role, ...f }) => f), warnings };
+}

package/dist/bundle.d.ts

@@ -1,27 +1,4 @@
-export type BundleFile = {
-    path: string;
-    content: string;
-    mediaType: string;
-};
-export type BundleWarning = {
-    path?: string;
-    message: string;
-};
-export type BundleResult = {
-    supported: boolean;
-    files: BundleFile[];
-    warnings: BundleWarning[];
-    message?: string;
-};
-export type BundleOptions = {
-    includeOpenScad?: boolean;
-    includeCadQuery?: boolean;
-    includeBom?: boolean;
-    includePartCad?: boolean;
-    prettyJson?: boolean;
-};
-export type WriteBundleOptions = {
-    overwrite?: boolean;
-};
+export type { BundleFile, BundleWarning, BundleResult, BundleOptions, WriteBundleOptions } from './bundle.core.js';
+import type { BundleResult, BundleOptions, WriteBundleOptions } from './bundle.core.js';
 export declare function createBundle(input: unknown, options?: BundleOptions): BundleResult;
 export declare function writeBundleToDirectory(bundle: BundleResult, outputDir: string, options?: WriteBundleOptions): void;

package/dist/bundle.js

@@ -1,88 +1,11 @@
 import fs from 'node:fs';
 import path from 'node:path';
 import { validatePrintSpec } from './validate.js';
-import { normalizePrintSpec } from './normalize.js';
-import { generateOpenScad } from './generators/openscad.js';
-import { generateCadQuery } from './generators/cadquery.js';
-import { extractBom, bomToMarkdown, bomToCsv, bomToSupplierOrderList } from './bom.js';
-const VERSION = '0.1.0';
-const jsonMedia = 'application/json';
-function j(spec, pretty) { return JSON.stringify(spec, null, pretty ? 2 : 0) + '\n'; }
-function add(files, path, content, mediaType, role) { files.push({ path, content, mediaType, role }); }
-function warn(warnings, message, path) { warnings.push(path ? { path, message } : { message }); }
-function safePartId(id) { return id.replace(/[^A-Za-z0-9._-]/g, '-'); }
-function bomFiles(files, base, bom) { if (!bom.length)
-    return; add(files, `${base}bom.md`, bomToMarkdown(bom) + '\n', 'text/markdown', 'bom-markdown'); add(files, `${base}bom.csv`, bomToCsv(bom) + '\n', 'text/csv', 'bom-csv'); add(files, `${base}supplier-order-list.txt`, bomToSupplierOrderList(bom) + '\n', 'text/plain', 'supplier-order-list'); }
-function cadForPart(spec, base, files, warnings, opts) { if (opts.includeOpenScad) {
-    const g = generateOpenScad(spec);
-    if (g.supported) {
-        add(files, `${base}cad/model.scad`, g.code, 'text/plain', 'openscad-source');
-        for (const m of g.warnings ?? [])
-            warn(warnings, m, `${base}cad/model.scad`);
-    }
-    else
-        warn(warnings, g.message ?? 'OpenSCAD generator unsupported', `${base}cad/model.scad`);
-} if (opts.includeCadQuery) {
-    const g = generateCadQuery(spec);
-    if (g.supported) {
-        add(files, `${base}cad/model.py`, g.code, 'text/x-python', 'cadquery-source');
-        for (const m of g.warnings ?? [])
-            warn(warnings, m, `${base}cad/model.py`);
-    }
-    else
-        warn(warnings, g.message ?? 'CadQuery generator unsupported', `${base}cad/model.py`);
-} }
-function readme(kind, spec, files, warnings, bomCount) { const lines = []; lines.push(`# ${kind === 'project' ? (spec.project?.label ?? 'printspec project') : (spec.part?.label ?? 'printspec part')}`, ''); if (kind === 'part')
-    lines.push(`Part type: ${spec.part?.type ?? 'unknown'}`);
-else {
-    if (spec.project?.description)
-        lines.push(spec.project.description, '');
-    lines.push('## Parts', ...(spec.project?.parts ?? []).map((p) => `- ${p.id}: ${p.label ?? p.id} (quantity ${p.quantity ?? 1})`), '');
-} lines.push(`printspec version: ${spec.printspecVersion ?? VERSION}`, '', '## Generated files', ...files.map(f => `- ${f.path} (${f.role})`), ''); lines.push('## BOM', bomCount ? `${bomCount} BOM item(s) included.` : 'No hardware/BOM items were found.', ''); lines.push('## Warnings', ...(warnings.length ? warnings.map(w => `- ${w.path ? `${w.path}: ` : ''}${w.message}`) : ['- None']), ''); lines.push('Generated CAD source should be reviewed before manufacturing.'); return lines.join('\n') + '\n'; }
-function partcad(spec, files) { const cq = files.filter(f => f.role === 'cadquery-source').sort((a, b) => a.path < b.path ? -1 : a.path > b.path ? 1 : 0); const name = spec.project?.partcad?.packageName ?? 'printspec-project'; const lines = ['package:', `  name: ${name}`, `  version: ${spec.project?.partcad?.packageVersion ?? VERSION}`, '  description: Experimental compatibility stub generated from printspec.', '', 'parts:']; for (const f of cq) {
-    const m = f.path.match(/^parts\/([^/]+)\//);
-    lines.push(`  - name: ${m?.[1] ?? 'model'}`, '    type: cadquery', `    path: ${f.path}`);
-} if (!cq.length)
-    lines.push('  []'); return lines.join('\n') + '\n'; }
-function manifest(kind, files, warnings, spec) { const entries = files.map(f => ({ path: f.path, mediaType: f.mediaType, role: f.role })).sort((a, b) => a.path < b.path ? -1 : a.path > b.path ? 1 : 0); entries.push({ path: 'bundle-manifest.json', mediaType: jsonMedia, role: 'bundle-manifest' }); entries.sort((a, b) => a.path < b.path ? -1 : a.path > b.path ? 1 : 0); return j({ bundleVersion: VERSION, createdBy: 'printspec', printspecVersion: spec.printspecVersion ?? VERSION, kind, files: entries, warnings }, true); }
+import { createBundleWithValidator } from './bundle.core.js';
 export function createBundle(input, options = {}) {
-    const r = validatePrintSpec(input);
-    if (!r.valid)
-        return { supported: false, files: [], warnings: [], message: `Validation failed: ${r.errors.slice(0, 3).join('; ')}` };
-    const spec = normalizePrintSpec(input);
-    const opts = { includeOpenScad: options.includeOpenScad !== false, includeCadQuery: options.includeCadQuery !== false, includeBom: options.includeBom !== false, includePartCad: options.includePartCad === true, prettyJson: options.prettyJson !== false };
-    const files = [];
-    const warnings = [];
-    const kind = spec.project ? 'project' : 'part';
-    add(files, 'printspec.json', j(spec, opts.prettyJson), jsonMedia, 'source-spec');
-    if (kind === 'part') {
-        cadForPart(spec, '', files, warnings, opts);
-        if (opts.includeBom)
-            bomFiles(files, 'bom/', extractBom(spec));
-    }
-    else {
-        for (const p of spec.project.parts ?? []) {
-            const id = safePartId(p.id);
-            if (p.spec) {
-                const ps = normalizePrintSpec(p.spec);
-                add(files, `parts/${id}/printspec.json`, j(ps, opts.prettyJson), jsonMedia, 'part-source-spec');
-                cadForPart(ps, `parts/${id}/`, files, warnings, opts);
-            }
-            else if (p.specPath)
-                warn(warnings, `External specPath references are not bundled yet: ${p.specPath}`, `parts/${id}/printspec.json`);
-        }
-        if (opts.includeBom)
-            bomFiles(files, 'bom/', extractBom(spec));
-        if (opts.includePartCad)
-            add(files, 'partcad.yaml', partcad(spec, files), 'text/yaml', 'partcad-stub');
-    }
-    const bomCount = extractBom(spec).length;
-    add(files, 'README.md', readme(kind, spec, files, warnings, bomCount), 'text/markdown', 'readme');
-    add(files, 'bundle-manifest.json', manifest(kind, files, warnings, spec), jsonMedia, 'bundle-manifest');
-    files.sort((a, b) => a.path < b.path ? -1 : a.path > b.path ? 1 : 0);
-    return { supported: true, files: files.map(({ role, ...f }) => f), warnings };
+    return createBundleWithValidator(validatePrintSpec, input, options);
 }
-function assertSafe(p) { if (!p || path.isAbsolute(p) || p.split(/[\\/]+/).includes('..'))
+function assertSafe(p) { if (!p || path.isAbsolute(p) || p.split(/[\/]+/).includes('..'))
     throw new Error(`Unsafe bundle path: ${p}`); }
 export function writeBundleToDirectory(bundle, outputDir, options = {}) { if (!bundle.supported)
     throw new Error(bundle.message ?? 'Unsupported bundle'); if (fs.existsSync(outputDir) && !options.overwrite)

package/dist/forms.browser.d.ts

@@ -0,0 +1,37 @@
+export type FormGroup = {
+    id: string;
+    title: string;
+    fields: string[];
+};
+export type FormField = {
+    name: string;
+    title: string;
+    description?: string;
+    required: boolean;
+    type: string;
+    control?: string;
+    unit?: string;
+    step?: number;
+    minimum?: number;
+    exclusiveMinimum?: number;
+    maximum?: number;
+    default?: unknown;
+    examples?: unknown[];
+    priority?: 'primary' | 'advanced';
+};
+export type FormMetadata = {
+    partType: string;
+    title: string;
+    description?: string;
+    fields: FormField[];
+    groups: FormGroup[];
+};
+export type PartFamilySummary = {
+    type: string;
+    title: string;
+    description?: string;
+    schemaFilename: string;
+    generatorSupported?: boolean;
+};
+export declare function listPartFamilies(): PartFamilySummary[];
+export declare function getPartFamilyFormMetadata(partType: string): FormMetadata;

package/dist/forms.browser.js

@@ -0,0 +1,68 @@
+import { schemas } from './schemas.browser.js';
+const generatorSupported = new Set(['rounded_rectangular_plate', 'spacer_block', 'round_spacer', 'electronics_standoff']);
+function partFamilyEntries() {
+    return Object.entries(schemas)
+        .map(([filename, schema]) => ({ filename, schema, type: schema?.properties?.type?.const }))
+        .filter((entry) => typeof entry.type === 'string' && !!entry.schema?.properties?.parameters)
+        .sort((a, b) => a.type.localeCompare(b.type));
+}
+function schemaType(field) {
+    if (typeof field?.type === 'string')
+        return field.type;
+    if (field?.$ref)
+        return 'object';
+    if (Array.isArray(field?.type))
+        return field.type.join('|');
+    return 'unknown';
+}
+export function listPartFamilies() {
+    return partFamilyEntries().map(({ type, filename, schema }) => ({
+        type,
+        title: schema.title ?? type,
+        description: schema.description,
+        schemaFilename: filename,
+        generatorSupported: generatorSupported.has(type),
+    }));
+}
+export function getPartFamilyFormMetadata(partType) {
+    const entry = partFamilyEntries().find((candidate) => candidate.type === partType);
+    if (!entry)
+        throw new Error(`Unsupported printspec part family: ${partType}`);
+    const parameters = entry.schema?.properties?.parameters;
+    const properties = parameters?.properties ?? {};
+    const required = new Set(parameters?.required ?? []);
+    const metadata = parameters?.['x-printspec-ui'] ?? {};
+    const known = new Set(Object.keys(properties));
+    const ordered = Array.isArray(metadata.order) ? metadata.order.filter((name) => known.has(name)) : Object.keys(properties).sort();
+    for (const name of Object.keys(properties).sort())
+        if (!ordered.includes(name))
+            ordered.push(name);
+    const groups = Array.isArray(metadata.groups) && metadata.groups.length
+        ? metadata.groups.map((group) => ({ id: String(group.id), title: String(group.title ?? group.id), fields: (group.fields ?? []).filter((name) => known.has(name)) }))
+        : [{ id: 'parameters', title: parameters?.title ?? 'Parameters', fields: ordered }];
+    return {
+        partType,
+        title: entry.schema.title ?? partType,
+        description: entry.schema.description,
+        fields: ordered.map((name) => {
+            const field = properties[name] ?? {};
+            return {
+                name,
+                title: field.title ?? name,
+                description: field.description,
+                required: required.has(name),
+                type: schemaType(field),
+                control: field['x-printspec-control'],
+                unit: field['x-printspec-unit'],
+                step: field['x-printspec-step'],
+                minimum: field.minimum,
+                exclusiveMinimum: field.exclusiveMinimum,
+                maximum: field.maximum,
+                default: field.default,
+                examples: field.examples,
+                priority: field['x-printspec-priority'],
+            };
+        }),
+        groups,
+    };
+}