circuitjson-toolkit 1.0.10 → 1.0.16

package/src/core/SelectedPartCircuitJsonExportAdapter.mjs

@@ -0,0 +1,335 @@
+import { CircuitJsonDocument } from './CircuitJsonDocument.mjs'
+
+/**
+ * Builds standards-shaped CircuitJSON for selected-part ZIP exports.
+ */
+export class SelectedPartCircuitJsonExportAdapter {
+    /**
+     * Builds a CircuitJSON element array for one selected part.
+     * @param {{ designator?: string, symbol?: object, footprint?: object }} selectedPart Selected part data.
+     * @param {object} documentModel Active document model.
+     * @param {string} partName Export artifact name.
+     * @returns {object[]}
+     */
+    static build(selectedPart, documentModel, partName) {
+        const designator = selectedPart.designator || 'selected-part'
+        const idToken =
+            SelectedPartCircuitJsonExportAdapter.#safeIdentifier(designator)
+        const sourceComponentId = 'source_component_' + idToken
+        const pcbComponentId = 'pcb_component_' + idToken
+        const circuitJson = [
+            {
+                type: 'source_project_metadata',
+                name: documentModel?.fileName || 'Selected part export',
+                software_used_string:
+                    documentModel?.sourceFormat || documentModel?.fileType || ''
+            },
+            {
+                type: 'source_component',
+                source_component_id: sourceComponentId,
+                name: partName,
+                ftype: 'simple_chip',
+                manufacturer_part_number: selectedPart.symbol?.value || '',
+                supplier_part_numbers: {}
+            },
+            {
+                type: 'schematic_component',
+                schematic_component_id: 'schematic_component_' + idToken,
+                source_component_id: sourceComponentId,
+                center: { x: 0, y: 0 },
+                size: SelectedPartCircuitJsonExportAdapter.#schematicSize(
+                    selectedPart
+                ),
+                rotation: 0
+            },
+            {
+                type: 'pcb_component',
+                pcb_component_id: pcbComponentId,
+                source_component_id: sourceComponentId,
+                center: SelectedPartCircuitJsonExportAdapter.#footprintCenter(
+                    selectedPart
+                ),
+                layer: 'top',
+                rotation: 0,
+                width: SelectedPartCircuitJsonExportAdapter.#footprintSize(
+                    selectedPart
+                ).width,
+                height: SelectedPartCircuitJsonExportAdapter.#footprintSize(
+                    selectedPart
+                ).height
+            },
+            ...SelectedPartCircuitJsonExportAdapter.#sourcePorts(
+                selectedPart,
+                sourceComponentId
+            ),
+            ...SelectedPartCircuitJsonExportAdapter.#pcbPads(
+                selectedPart,
+                pcbComponentId
+            )
+        ]
+
+        CircuitJsonDocument.assertModel(circuitJson)
+        return circuitJson
+    }
+
+    /**
+     * Builds source port entries.
+     * @param {{ symbol?: { pins?: object[] } }} selectedPart Selected part data.
+     * @param {string} sourceComponentId Source component id.
+     * @returns {object[]}
+     */
+    static #sourcePorts(selectedPart, sourceComponentId) {
+        return SelectedPartCircuitJsonExportAdapter.#array(
+            selectedPart.symbol?.pins
+        ).map((pin, index) => {
+            const pinName = String(pin.name || index + 1)
+            const pinNumber = String(pin.number || index + 1)
+            const entry = {
+                type: 'source_port',
+                source_port_id:
+                    sourceComponentId +
+                    '_port_' +
+                    SelectedPartCircuitJsonExportAdapter.#safeIdentifier(
+                        pinNumber
+                    ),
+                source_component_id: sourceComponentId,
+                name: pinName,
+                port_hints: [pinNumber]
+            }
+            const numericPinNumber =
+                SelectedPartCircuitJsonExportAdapter.#numericPinNumber(
+                    pinNumber
+                )
+            if (numericPinNumber !== null) entry.pin_number = numericPinNumber
+            return entry
+        })
+    }
+
+    /**
+     * Builds PCB SMT pad entries.
+     * @param {{ footprint?: { pads?: object[] } }} selectedPart Selected part data.
+     * @param {string} pcbComponentId PCB component id.
+     * @returns {object[]}
+     */
+    static #pcbPads(selectedPart, pcbComponentId) {
+        return SelectedPartCircuitJsonExportAdapter.#array(
+            selectedPart.footprint?.pads
+        ).map((pad, index) =>
+            SelectedPartCircuitJsonExportAdapter.#pcbPad(
+                pad,
+                index,
+                pcbComponentId
+            )
+        )
+    }
+
+    /**
+     * Builds one PCB SMT pad entry.
+     * @param {object} pad Pad data.
+     * @param {number} index Pad index.
+     * @param {string} pcbComponentId PCB component id.
+     * @returns {object}
+     */
+    static #pcbPad(pad, index, pcbComponentId) {
+        const padNumber = String(pad.number || index + 1)
+        const width = SelectedPartCircuitJsonExportAdapter.#number(pad.width, 1)
+        const height = SelectedPartCircuitJsonExportAdapter.#number(
+            pad.height,
+            1
+        )
+        const rotation = SelectedPartCircuitJsonExportAdapter.#number(
+            pad.ccw_rotation ?? pad.rotation,
+            0
+        )
+        const shape =
+            rotation !== 0
+                ? 'rotated_rect'
+                : SelectedPartCircuitJsonExportAdapter.#padShape(
+                      pad,
+                      width,
+                      height
+                  )
+        const entry = {
+            type: 'pcb_smtpad',
+            shape,
+            pcb_smtpad_id:
+                pcbComponentId +
+                '_pad_' +
+                SelectedPartCircuitJsonExportAdapter.#safeIdentifier(padNumber),
+            pcb_component_id: pcbComponentId,
+            port_hints: [padNumber],
+            x: SelectedPartCircuitJsonExportAdapter.#number(pad.x, 0),
+            y: SelectedPartCircuitJsonExportAdapter.#number(pad.y, 0),
+            layer: SelectedPartCircuitJsonExportAdapter.#padLayer(pad)
+        }
+
+        if (shape === 'circle') {
+            entry.radius = Math.max(width, height) / 2
+        } else {
+            entry.width = width
+            entry.height = height
+        }
+
+        if (shape === 'rotated_rect') entry.ccw_rotation = rotation
+        return entry
+    }
+
+    /**
+     * Resolves the schematic component size.
+     * @param {{ symbol?: { pins?: object[] } }} selectedPart Selected part data.
+     * @returns {{ width: number, height: number }}
+     */
+    static #schematicSize(selectedPart) {
+        const pinCount = SelectedPartCircuitJsonExportAdapter.#array(
+            selectedPart.symbol?.pins
+        ).length
+        const edge = Math.max(2.54, Math.ceil(Math.sqrt(pinCount || 1)) * 2.54)
+        return { width: edge, height: edge }
+    }
+
+    /**
+     * Resolves footprint size from owned pads.
+     * @param {{ footprint?: { pads?: object[] } }} selectedPart Selected part data.
+     * @returns {{ width: number, height: number }}
+     */
+    static #footprintSize(selectedPart) {
+        const bounds =
+            SelectedPartCircuitJsonExportAdapter.#footprintBounds(selectedPart)
+        return {
+            width: Math.max(bounds.maxX - bounds.minX, 1),
+            height: Math.max(bounds.maxY - bounds.minY, 1)
+        }
+    }
+
+    /**
+     * Resolves footprint center from owned pads.
+     * @param {{ footprint?: { pads?: object[] } }} selectedPart Selected part data.
+     * @returns {{ x: number, y: number }}
+     */
+    static #footprintCenter(selectedPart) {
+        const bounds =
+            SelectedPartCircuitJsonExportAdapter.#footprintBounds(selectedPart)
+        return {
+            x: (bounds.minX + bounds.maxX) / 2,
+            y: (bounds.minY + bounds.maxY) / 2
+        }
+    }
+
+    /**
+     * Resolves footprint pad bounds.
+     * @param {{ footprint?: { pads?: object[] } }} selectedPart Selected part data.
+     * @returns {{ minX: number, minY: number, maxX: number, maxY: number }}
+     */
+    static #footprintBounds(selectedPart) {
+        const pads = SelectedPartCircuitJsonExportAdapter.#array(
+            selectedPart.footprint?.pads
+        )
+        if (!pads.length)
+            return { minX: -0.5, minY: -0.5, maxX: 0.5, maxY: 0.5 }
+
+        return pads.reduce(
+            (bounds, pad) => {
+                const x = SelectedPartCircuitJsonExportAdapter.#number(pad.x, 0)
+                const y = SelectedPartCircuitJsonExportAdapter.#number(pad.y, 0)
+                const halfWidth =
+                    SelectedPartCircuitJsonExportAdapter.#number(pad.width, 1) /
+                    2
+                const halfHeight =
+                    SelectedPartCircuitJsonExportAdapter.#number(
+                        pad.height,
+                        1
+                    ) / 2
+                return {
+                    minX: Math.min(bounds.minX, x - halfWidth),
+                    minY: Math.min(bounds.minY, y - halfHeight),
+                    maxX: Math.max(bounds.maxX, x + halfWidth),
+                    maxY: Math.max(bounds.maxY, y + halfHeight)
+                }
+            },
+            {
+                minX: Infinity,
+                minY: Infinity,
+                maxX: -Infinity,
+                maxY: -Infinity
+            }
+        )
+    }
+
+    /**
+     * Resolves an SMT pad shape.
+     * @param {object} pad Pad data.
+     * @param {number} width Pad width.
+     * @param {number} height Pad height.
+     * @returns {string}
+     */
+    static #padShape(pad, width, height) {
+        const rawShape = String(
+            pad.shape || pad.shapeTopName || pad.shapeName || ''
+        ).toLowerCase()
+        if (
+            rawShape.includes('circle') ||
+            rawShape.includes('round') ||
+            rawShape.includes('oval')
+        ) {
+            return width === height ? 'circle' : 'rect'
+        }
+        return 'rect'
+    }
+
+    /**
+     * Resolves an SMT pad layer.
+     * @param {object} pad Pad data.
+     * @returns {string}
+     */
+    static #padLayer(pad) {
+        const layer = String(pad.layer || pad.layerName || '').toLowerCase()
+        if (
+            layer.includes('bottom') ||
+            layer === 'bottom' ||
+            pad.layerId === 32
+        ) {
+            return 'bottom'
+        }
+        return 'top'
+    }
+
+    /**
+     * Returns a number pin when a pin token is numeric.
+     * @param {unknown} value Candidate pin number.
+     * @returns {number | null}
+     */
+    static #numericPinNumber(value) {
+        const text = String(value || '').trim()
+        const parsed = Number(text)
+        return text && Number.isFinite(parsed) ? parsed : null
+    }
+
+    /**
+     * Creates a safe CircuitJSON id token.
+     * @param {unknown} value Raw value.
+     * @returns {string}
+     */
+    static #safeIdentifier(value) {
+        return String(value || 'selected_part').replace(/[^a-z0-9_]/giu, '_')
+    }
+
+    /**
+     * Normalizes a possible array.
+     * @param {unknown} value Candidate array.
+     * @returns {object[]}
+     */
+    static #array(value) {
+        return Array.isArray(value) ? value : []
+    }
+
+    /**
+     * Reads a finite number with fallback.
+     * @param {unknown} value Candidate number.
+     * @param {number} fallback Fallback number.
+     * @returns {number}
+     */
+    static #number(value, fallback) {
+        const parsed = Number(value)
+        return Number.isFinite(parsed) ? parsed : fallback
+    }
+}

package/src/index.mjs

@@ -4,7 +4,9 @@ export { CircuitJsonElementValidator } from './core/CircuitJsonElementValidator.
 export { CircuitJsonIndexer } from './core/CircuitJsonIndexer.mjs'
 export { CircuitJsonManufacturingBuilder } from './core/CircuitJsonManufacturingBuilder.mjs'
 export { CircuitJsonParser } from './core/CircuitJsonParser.mjs'
+export { CircuitJsonSourceMetadata } from './core/CircuitJsonSourceMetadata.mjs'
 export { CircuitJsonSupportMatrixBuilder } from './core/CircuitJsonSupportMatrixBuilder.mjs'
 export { CircuitJsonUnits } from './core/CircuitJsonUnits.mjs'
 export { SpiceCompatibilityPreprocessor } from './core/spice/SpiceCompatibilityPreprocessor.mjs'
 export { SpiceSimulationService } from './core/spice/SpiceSimulationService.mjs'
+export * from './renderers.mjs'

package/src/renderers.mjs

@@ -0,0 +1,29 @@
+export { CircuitJsonManufacturingDownloadBuilder } from './core/CircuitJsonManufacturingDownloadBuilder.mjs'
+export { CircuitJsonPcbClearanceDiagnostics } from './core/CircuitJsonPcbClearanceDiagnostics.mjs'
+export { CircuitJsonPcbCopperGeometry } from './core/CircuitJsonPcbCopperGeometry.mjs'
+export { CircuitJsonPcbDrawingStyle } from './core/CircuitJsonPcbDrawingStyle.mjs'
+export { CircuitJsonPcbHolePrimitiveModel } from './core/CircuitJsonPcbHolePrimitiveModel.mjs'
+export { CircuitJsonPcbNetMetadata } from './core/CircuitJsonPcbNetMetadata.mjs'
+export { CircuitJsonPcbPadPrimitiveModel } from './core/CircuitJsonPcbPadPrimitiveModel.mjs'
+export { CircuitJsonPcbPrimitiveArtwork } from './core/CircuitJsonPcbPrimitiveArtwork.mjs'
+export { CircuitJsonPcbPrimitiveBuilder } from './core/CircuitJsonPcbPrimitiveBuilder.mjs'
+export { CircuitJsonPcbPrimitiveFields } from './core/CircuitJsonPcbPrimitiveFields.mjs'
+export { CircuitJsonPcbPrimitiveGeometry } from './core/CircuitJsonPcbPrimitiveGeometry.mjs'
+export { CircuitJsonPcbPrimitiveGroups } from './core/CircuitJsonPcbPrimitiveGroups.mjs'
+export { CircuitJsonPcbPrimitiveIndex } from './core/CircuitJsonPcbPrimitiveIndex.mjs'
+export { CircuitJsonPcbPrimitiveOverlays } from './core/CircuitJsonPcbPrimitiveOverlays.mjs'
+export { CircuitJsonPcbTraceLengthModel } from './core/CircuitJsonPcbTraceLengthModel.mjs'
+export { CircuitJsonPcbZonePrimitiveBuilder } from './core/CircuitJsonPcbZonePrimitiveBuilder.mjs'
+export { PcbBoundsSelectionModel } from './core/PcbBoundsSelectionModel.mjs'
+export { PcbCandidateSelectionModel } from './core/PcbCandidateSelectionModel.mjs'
+export { PcbDiagnosticFocusModel } from './core/PcbDiagnosticFocusModel.mjs'
+export { PcbInteractionPrimitiveModel } from './core/PcbInteractionPrimitiveModel.mjs'
+export { SelectedPartCircuitJsonExportAdapter } from './core/SelectedPartCircuitJsonExportAdapter.mjs'
+export { CircuitJsonPcbPrimitiveAttributeRenderer } from './ui/CircuitJsonPcbPrimitiveAttributeRenderer.mjs'
+export { CircuitJsonPcbSvgRenderer } from './ui/CircuitJsonPcbSvgRenderer.mjs'
+export { CircuitJsonPcbViaSvgRenderer } from './ui/CircuitJsonPcbViaSvgRenderer.mjs'
+export { CircuitJsonSchematicSvgArcPath } from './ui/CircuitJsonSchematicSvgArcPath.mjs'
+export { CircuitJsonSchematicSvgPortMetadata } from './ui/CircuitJsonSchematicSvgPortMetadata.mjs'
+export { CircuitJsonSchematicSvgPrimitiveAttributes } from './ui/CircuitJsonSchematicSvgPrimitiveAttributes.mjs'
+export { CircuitJsonSchematicSvgRenderer } from './ui/CircuitJsonSchematicSvgRenderer.mjs'
+export { CircuitJsonSchematicTableSvgRenderer } from './ui/CircuitJsonSchematicTableSvgRenderer.mjs'

package/src/ui/CircuitJsonPcbPrimitiveAttributeRenderer.mjs

@@ -0,0 +1,128 @@
+/**
+ * Renders shared SVG attributes for CircuitJSON PCB primitives.
+ */
+export class CircuitJsonPcbPrimitiveAttributeRenderer {
+    /**
+     * Renders data, paint, and style attributes for one primitive.
+     * @param {object} primitive Primitive row.
+     * @returns {string}
+     */
+    static render(primitive) {
+        const dataAttributes = [
+            ['data-pcb-primitive-id', primitive.id],
+            ['data-layer', primitive.layer],
+            ['data-net', primitive.netName],
+            ['data-component-key', primitive.componentKey],
+            ['data-footprint-id', primitive.footprintId],
+            ['data-pcb-group-ids', (primitive.groupIds || []).join(' ')],
+            ['data-subcircuit-ids', (primitive.subcircuitIds || []).join(' ')],
+            ['data-source-net-id', primitive.sourceNetId],
+            ['data-net-color', primitive.netColor],
+            ['data-knockout', primitive.isKnockout ? 'true' : ''],
+            ['data-pcb-component-side', this.#componentSide(primitive)],
+            [
+                'data-solder-mask-covered',
+                primitive.coveredWithSolderMask === undefined ||
+                primitive.coveredWithSolderMask === null
+                    ? ''
+                    : String(Boolean(primitive.coveredWithSolderMask))
+            ],
+            ['data-primitive-kind', primitive.kind]
+        ]
+            .filter((entry) => String(entry[1] || '').trim())
+            .map(([name, value]) => name + '="' + this.#escapeHtml(value) + '"')
+        const style = this.#styleAttribute(primitive)
+        const attributes = [
+            ...dataAttributes,
+            ...this.#paintAttributes(primitive)
+        ]
+        if (style) attributes.push(style)
+        return attributes.join(' ')
+    }
+
+    /**
+     * Resolves a primitive side from explicit side or layer metadata.
+     * @param {object} primitive Primitive row.
+     * @returns {string}
+     */
+    static #componentSide(primitive) {
+        const side = String(primitive.side || '')
+            .trim()
+            .toLowerCase()
+        if (side === 'top' || side === 'bottom') return side
+        const layer = String(primitive.layer || '')
+            .trim()
+            .toLowerCase()
+        return layer === 'top' || layer === 'bottom' ? layer : ''
+    }
+
+    /**
+     * Builds an inline style attribute for primitive metadata.
+     * @param {object} primitive Primitive row.
+     * @returns {string}
+     */
+    static #styleAttribute(primitive) {
+        const netColor = this.#safeColor(primitive.netColor)
+        if (!netColor) return ''
+        return 'style="--pcb-net-color: ' + netColor + '"'
+    }
+
+    /**
+     * Builds explicit SVG paint attributes for documentation primitives.
+     * @param {object} primitive Primitive row.
+     * @returns {string[]}
+     */
+    static #paintAttributes(primitive) {
+        const attributes = []
+        const stroke = this.#safeColor(primitive.strokeColor)
+        const fill = this.#safeColor(primitive.fillColor)
+        const dashArray = this.#safeDashArray(primitive.dashArray)
+        if (stroke) attributes.push('stroke="' + stroke + '"')
+        if (fill) attributes.push('fill="' + fill + '"')
+        if (dashArray) {
+            attributes.push(
+                'stroke-dasharray="' + this.#escapeHtml(dashArray) + '"'
+            )
+        }
+        return attributes
+    }
+
+    /**
+     * Returns a color safe for SVG attributes and CSS variables.
+     * @param {unknown} value Color candidate.
+     * @returns {string}
+     */
+    static #safeColor(value) {
+        const text = String(value || '').trim()
+        return /^#[0-9a-f]{3,8}$/iu.test(text) ? text : ''
+    }
+
+    /**
+     * Returns a numeric dash array safe for SVG attributes.
+     * @param {unknown} value Dash array candidate.
+     * @returns {string}
+     */
+    static #safeDashArray(value) {
+        const parts = String(value || '')
+            .trim()
+            .split(/\s+/u)
+            .filter(Boolean)
+        if (!parts.length) return ''
+        return parts.every((part) => Number.isFinite(Number(part)))
+            ? parts.join(' ')
+            : ''
+    }
+
+    /**
+     * Escapes markup text.
+     * @param {unknown} value Raw value.
+     * @returns {string}
+     */
+    static #escapeHtml(value) {
+        return String(value ?? '')
+            .replaceAll('&', '&')
+            .replaceAll('<', '&lt;')
+            .replaceAll('>', '&gt;')
+            .replaceAll('"', '&quot;')
+    }
+}