altium-toolkit 1.0.10 → 1.1.0

package/docs/api.md

@@ -65,8 +65,8 @@ Specialized parser helpers are exported for lower-level integrations, including
 `PcbDimensionParser`, `PcbEmbeddedFontExtractor`,
 `PcbExtendedPrimitiveInformationParser`, `PcbFontMetricsParser`,
 `LibraryRenderManifestBuilder`, `LibrarySearchIndex`,
-`PcbOwnershipGraphBuilder`, `PcbPadStackParser`,
-`PcbPickPlacePositionResolver`,
+`PcbBomProfileBuilder`, `PcbLayerStackFidelityReportBuilder`,
+`PcbOwnershipGraphBuilder`, `PcbPadStackParser`, `PcbPickPlacePositionResolver`,
 `ProjectAnnotationParser`, `ProjectDesignBundleBuilder`,
 `ProjectNetlistExporter`, `ProjectVariantViewBuilder`,
 `PcbMechanicalLayerPairParser`, `PcbSpecialStringResolver`, `PcbUnionParser`,
@@ -101,6 +101,10 @@ embedded font payload and metric shape that `.PcbDoc` and `.PcbLib` parsing adds
 to normalized models. `PcbRawRecordRegistry` exposes immutable primitive stream
 descriptors and the raw-record preservation helpers used by the PcbDoc/PcbLib
 extractors.
+`PcbBomProfileBuilder` exposes PCB-only BOM grouping and parameter alias
+normalization. `PcbLayerStackFidelityReportBuilder` classifies layer-stack
+source evidence and unsupported native-regeneration limits for deterministic
+QA/reporting.
 `LibraryRenderManifestBuilder` and `LibrarySearchIndex` expose deterministic
 SchLib/PcbLib render/export manifests plus exact, keyword, and fuzzy lookup
 helpers. `PcbStatisticsBuilder` emits board QA summaries used by `.PcbDoc`

package/docs/model-format.md

@@ -17,11 +17,22 @@ Every parser result is an array of elements with a `type` field. The adapter
 emits Circuit JSON elements for source project metadata, source components,
 ports, nets, schematic symbols, schematic lines, schematic text, PCB boards,
 PCB components, PCB pads, PCB traces, and PCB vias where those structures are
-available in the source document.
+available in the source document. Altium Toolkit sidecar contracts that do not
+map to upstream Circuit JSON element families are serialized as custom
+`altium_toolkit_*` elements. Each sidecar element includes a stable
+`altium_toolkit_sidecar_id`, a `source_document` identity block, the sidecar
+`schema`, and the original normalized sidecar object in `payload`.
+
+Current custom sidecar element types include PCB layer stacks, rigid-flex
+topology, PCB review metadata, placed-footprint extraction manifests, PCB
+library parity reports, project OutJob digests, project document graphs,
+BOM/PnP reconciliation reports, Draftsman image payloads, Draftsman board-view
+metadata, contract-gate reports, and host-capability diagnostics.
 
 Use `CircuitJsonModelSchema.isModel(result)` to validate that a value is a
 Circuit JSON array. `JSON.stringify(result)` serializes only the Circuit JSON
-elements; compatibility fields are intentionally omitted from serialized JSON.
+elements, including custom `altium_toolkit_*` sidecar elements; compatibility
+fields are intentionally omitted from serialized JSON.
 
 ## Renderer Compatibility Fields
 
@@ -294,6 +305,12 @@ component bodies. `pcbLibrary.renderManifest` exposes stable footprint SVG keys,
 per-layer SVG keys, layer descriptors, and embedded asset descriptors. Asset
 descriptors may include native format, wrapper type, byte size, checksum, and
 structured diagnostics when extraction supplied that metadata.
+`LibraryRenderManifestBuilder.buildSchematicExtractionManifest()` adds a
+read-only database-library audit plan for placed schematic symbols, including
+preserved versus stripped parameter names and stripped implementation keys.
+`LibraryRenderManifestBuilder.buildSchematicTemplateExtractionManifest()`
+summarizes template identity, owned records, fonts, title-block fields, and
+missing template parameters without generating template files.
 `LibrarySearchIndex` provides exact, keyword, and fuzzy symbol/footprint lookup
 helpers over parsed library read models.
 
@@ -340,6 +357,13 @@ metadata sidecar as the composite SVG, with `view.kind` set to `layer`, a
 single included layer id, and `layerSet.layerView` describing the exported
 layer.
 
+PCB documents expose `pcb.bomProfile` for PCB-only BOM grouping and parameter
+alias normalization. `pcb.layerStackReadModel.fidelityReport` classifies
+semantic layer-stack data, preserved native cache evidence, interchange-only
+fields, and unsupported native-regeneration reasons. Draftsman digests preserve
+typed font-style records, note geometry, note border/fill state, and picture
+geometry when those fields are available in the container.
+
 External model placements in the 3D scene description include a `projection`
 diagnostic object. The `source` explains whether bounds came from an authored
 projection override, resolved model bounds, nearby pad-span fallback,
@@ -367,5 +391,6 @@ Consumers should treat unknown fields as additive within the same schema id.
 Parser fixes may add detail, but existing field names and shapes should stay
 compatible unless a new schema id explicitly documents a model migration.
 Focused machine-readable schemas are available under
-`docs/schemas/altium_toolkit/` for the normalized root, project bundle, netlist
-JSON, schematic SVG semantic metadata, and PCB SVG semantic metadata contracts.
+`docs/schemas/altium_toolkit/` for the normalized root plus focused project,
+netlist, SVG, PCB review, layer-stack, Draftsman, library, and CI/reporting
+contracts.

package/docs/schemas/altium_toolkit/ci_artifact_bundle_a1.schema.json

@@ -16,6 +16,7 @@
         "schematicSvgs",
         "pcbLayerSvgs",
         "statistics",
+        "contractGate",
         "diagnostics"
     ],
     "properties": {
@@ -69,6 +70,9 @@
         "statistics": {
             "type": "object"
         },
+        "contractGate": {
+            "$ref": "contract_gate_a1.schema.json"
+        },
         "diagnostics": {
             "type": "array"
         }

package/docs/schemas/altium_toolkit/contract_gate_a1.schema.json

@@ -0,0 +1,34 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "altium-toolkit.contract-gate.a1",
+    "title": "Altium Toolkit Contract Gate A1",
+    "type": "object",
+    "additionalProperties": true,
+    "required": ["schema", "status", "summary", "gates", "svgLinkReports"],
+    "properties": {
+        "schema": {
+            "const": "altium-toolkit.contract-gate.a1"
+        },
+        "status": {
+            "enum": ["pass", "fail"]
+        },
+        "summary": {
+            "type": "object",
+            "additionalProperties": true
+        },
+        "gates": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": true
+            }
+        },
+        "svgLinkReports": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": true
+            }
+        }
+    }
+}

package/docs/schemas/altium_toolkit/draftsman_board_view_cache_a1.schema.json

@@ -0,0 +1,115 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "altium-toolkit.draftsman.board-view-cache.a1",
+    "title": "Altium Toolkit Draftsman Board View Cache A1",
+    "type": "object",
+    "additionalProperties": true,
+    "required": [
+        "schema",
+        "summary",
+        "layerColors",
+        "pcbParameters",
+        "boardAssemblyViews",
+        "boardFabricationViews",
+        "boardProjections",
+        "generatedGeometry",
+        "cacheLayers",
+        "displayLayers",
+        "cachePrimitives",
+        "highlightGroups",
+        "layerTiles",
+        "diagnostics"
+    ],
+    "properties": {
+        "schema": {
+            "const": "altium-toolkit.draftsman.board-view-cache.a1"
+        },
+        "summary": {
+            "type": "object",
+            "additionalProperties": true
+        },
+        "layerColors": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": true
+            }
+        },
+        "pcbParameters": {
+            "type": "object",
+            "additionalProperties": {
+                "type": "string"
+            }
+        },
+        "boardAssemblyViews": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": true
+            }
+        },
+        "boardFabricationViews": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": true
+            }
+        },
+        "boardProjections": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": true
+            }
+        },
+        "generatedGeometry": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": true
+            }
+        },
+        "cacheLayers": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": true
+            }
+        },
+        "displayLayers": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": true
+            }
+        },
+        "cachePrimitives": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": true
+            }
+        },
+        "highlightGroups": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": true
+            }
+        },
+        "layerTiles": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": true
+            }
+        },
+        "diagnostics": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": true
+            }
+        }
+    }
+}

package/docs/schemas/altium_toolkit/draftsman_digest_a1.schema.json

@@ -12,6 +12,23 @@
         "sourceDocumentName": {
             "type": "string"
         },
+        "documentOptions": {
+            "type": "object",
+            "additionalProperties": true
+        },
+        "styles": {
+            "type": "object",
+            "additionalProperties": true,
+            "properties": {
+                "fontStyles": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                }
+            }
+        },
         "pages": {
             "type": "array",
             "items": {
@@ -23,10 +40,124 @@
                     "titleBlocks",
                     "notes",
                     "images",
+                    "zones",
+                    "items",
                     "unsupportedRawItems"
-                ]
+                ],
+                "properties": {
+                    "pageSetup": {
+                        "type": "object",
+                        "additionalProperties": true
+                    },
+                    "zones": {
+                        "type": "array",
+                        "items": {
+                            "type": "object",
+                            "additionalProperties": true
+                        }
+                    },
+                    "items": {
+                        "type": "array",
+                        "items": {
+                            "type": "object",
+                            "additionalProperties": true
+                        }
+                    }
+                }
             }
         },
+        "imagePayloads": {
+            "type": "object",
+            "required": ["schema", "summary", "payloads", "diagnostics"],
+            "properties": {
+                "schema": {
+                    "const": "altium-toolkit.draftsman.image-payloads.a1"
+                },
+                "summary": {
+                    "type": "object",
+                    "additionalProperties": true
+                },
+                "payloads": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "diagnostics": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                }
+            },
+            "additionalProperties": true
+        },
+        "boardViewMetadata": {
+            "type": "object",
+            "required": [
+                "schema",
+                "summary",
+                "layerColors",
+                "pcbParameters",
+                "boardAssemblyViews",
+                "boardFabricationViews",
+                "boardProjections",
+                "generatedGeometry"
+            ],
+            "properties": {
+                "schema": {
+                    "const": "altium-toolkit.draftsman.board-view-cache.a1"
+                },
+                "summary": {
+                    "type": "object",
+                    "additionalProperties": true
+                },
+                "layerColors": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "pcbParameters": {
+                    "type": "object",
+                    "additionalProperties": {
+                        "type": "string"
+                    }
+                },
+                "boardAssemblyViews": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "boardFabricationViews": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "boardProjections": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "generatedGeometry": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                }
+            },
+            "additionalProperties": true
+        },
         "indexes": {
             "type": "object",
             "additionalProperties": true

package/docs/schemas/altium_toolkit/host_capabilities_a1.schema.json

@@ -0,0 +1,39 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "altium-toolkit.host-capabilities.a1",
+    "title": "Altium Toolkit Host Capabilities A1",
+    "type": "object",
+    "additionalProperties": true,
+    "required": ["schema", "host", "summary", "capabilities", "diagnostics"],
+    "properties": {
+        "schema": {
+            "const": "altium-toolkit.host-capabilities.a1"
+        },
+        "host": {
+            "type": "object",
+            "additionalProperties": true
+        },
+        "summary": {
+            "type": "object",
+            "additionalProperties": true
+        },
+        "capabilities": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": true
+            }
+        },
+        "readiness": {
+            "type": "object",
+            "additionalProperties": true
+        },
+        "diagnostics": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": true
+            }
+        }
+    }
+}

package/docs/schemas/altium_toolkit/library_merge_plan_a1.schema.json

@@ -0,0 +1,56 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "altium-toolkit.library.merge-plan.a1",
+    "title": "Altium Toolkit Library Merge Plan A1",
+    "type": "object",
+    "additionalProperties": true,
+    "required": [
+        "schema",
+        "strategy",
+        "summary",
+        "duplicateSymbols",
+        "embeddedAssets",
+        "fontDependencies",
+        "diagnostics"
+    ],
+    "properties": {
+        "schema": {
+            "const": "altium-toolkit.library.merge-plan.a1"
+        },
+        "strategy": {
+            "type": "string"
+        },
+        "summary": {
+            "type": "object",
+            "additionalProperties": true
+        },
+        "duplicateSymbols": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": true
+            }
+        },
+        "embeddedAssets": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": true
+            }
+        },
+        "fontDependencies": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": true
+            }
+        },
+        "diagnostics": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": true
+            }
+        }
+    }
+}

package/docs/schemas/altium_toolkit/library_qa_a1.schema.json

@@ -0,0 +1,70 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "altium-toolkit.library.qa.a1",
+    "title": "Altium Toolkit Library QA A1",
+    "type": "object",
+    "additionalProperties": true,
+    "required": [
+        "schema",
+        "summary",
+        "duplicateSymbols",
+        "duplicateFootprints",
+        "staleImplementations",
+        "missingModels",
+        "multipartMismatches"
+    ],
+    "properties": {
+        "schema": {
+            "const": "altium-toolkit.library.qa.a1"
+        },
+        "summary": {
+            "type": "object",
+            "additionalProperties": true
+        },
+        "duplicateSymbols": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": true
+            }
+        },
+        "duplicateFootprints": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": true
+            }
+        },
+        "staleImplementations": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": true
+            }
+        },
+        "missingModels": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": true
+            }
+        },
+        "multipartMismatches": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": true
+            }
+        },
+        "mergePlan": {
+            "$ref": "library_merge_plan_a1.schema.json"
+        },
+        "issues": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": true
+            }
+        }
+    }
+}