altium-toolkit 1.0.9 → 1.1.0

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

@@ -24,8 +24,10 @@
                 "pcb",
                 "pcb-library",
                 "project",
+                "project-script",
                 "project-annotation",
                 "integrated-library",
+                "draftsman",
                 "design-bundle"
             ]
         },
@@ -35,8 +37,10 @@
                 "PcbDoc",
                 "PcbLib",
                 "PrjPcb",
+                "PrjScr",
                 "Annotation",
                 "IntLib",
+                "PCBDwf",
                 "ProjectDesignBundle"
             ]
         },
@@ -157,7 +161,16 @@
                 "components": {
                     "type": "array",
                     "items": {
-                        "$ref": "#/$defs/pcbComponent"
+                        "allOf": [
+                            {
+                                "$ref": "#/$defs/pcbComponent"
+                            }
+                        ],
+                        "properties": {
+                            "componentKind": {
+                                "$ref": "#/$defs/componentKindPolicy"
+                            }
+                        }
                     }
                 },
                 "rules": {
@@ -166,6 +179,9 @@
                         "$ref": "#/$defs/pcbRule"
                     }
                 },
+                "bomProfile": {
+                    "$ref": "#/$defs/pcbBomProfile"
+                },
                 "dimensions": {
                     "type": "array",
                     "items": {
@@ -187,6 +203,15 @@
                 "pickPlace": {
                     "$ref": "#/$defs/pickPlaceModel"
                 },
+                "routeAnalysis": {
+                    "$ref": "#/$defs/pcbRouteAnalysis"
+                },
+                "reviewMetadata": {
+                    "$ref": "#/$defs/pcbReviewMetadata"
+                },
+                "footprintExtractionManifest": {
+                    "$ref": "#/$defs/pcbPlacedFootprintExtraction"
+                },
                 "embeddedFonts": {
                     "$ref": "#/$defs/embeddedFonts"
                 },
@@ -196,6 +221,12 @@
                 "layerSubstacks": {
                     "$ref": "#/$defs/layerSubstacks"
                 },
+                "layerStackReadModel": {
+                    "$ref": "#/$defs/pcbLayerStackReadModel"
+                },
+                "rigidFlexTopology": {
+                    "$ref": "#/$defs/pcbRigidFlexTopology"
+                },
                 "boardRegionContexts": {
                     "$ref": "#/$defs/boardRegionContexts"
                 },
@@ -281,12 +312,57 @@
                 },
                 "renderManifest": {
                     "$ref": "#/$defs/libraryRenderManifest"
+                },
+                "parityReport": {
+                    "$ref": "#/$defs/pcbLibraryParityReport"
                 }
             },
             "additionalProperties": true
         },
         "project": {
-            "type": "object"
+            "type": "object",
+            "properties": {
+                "documentGraph": {
+                    "$ref": "#/$defs/projectDocumentGraph"
+                },
+                "outJobDigest": {
+                    "$ref": "#/$defs/projectOutJobDigest"
+                }
+            },
+            "additionalProperties": true
+        },
+        "projectScript": {
+            "type": "object",
+            "properties": {
+                "name": {
+                    "type": "string"
+                },
+                "documents": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "scripts": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "sections": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                }
+            },
+            "additionalProperties": true
+        },
+        "units": {
+            "$ref": "#/$defs/units"
         },
         "variants": {
             "type": "array",
@@ -329,6 +405,14 @@
         "integratedLibrary": {
             "$ref": "#/$defs/integratedLibrary"
         },
+        "draftsman": {
+            "$ref": "#/$defs/draftsmanDigest",
+            "properties": {
+                "boardViewMetadata": {
+                    "$ref": "#/$defs/draftsmanBoardViewCache"
+                }
+            }
+        },
         "bom": {
             "type": "array",
             "items": {
@@ -337,6 +421,9 @@
         },
         "pnp": {
             "$ref": "#/$defs/pickPlaceModel"
+        },
+        "reconciliation": {
+            "$ref": "#/$defs/projectBomPnpReconciliation"
         }
     },
     "oneOf": [
@@ -406,6 +493,17 @@
                 }
             }
         },
+        {
+            "required": ["draftsman"],
+            "properties": {
+                "kind": {
+                    "const": "draftsman"
+                },
+                "fileType": {
+                    "const": "PCBDwf"
+                }
+            }
+        },
         {
             "required": ["project", "sheets", "schematic_hierarchy", "indexes"],
             "properties": {
@@ -451,6 +549,221 @@
             },
             "additionalProperties": true
         },
+        "projectDocumentGraph": {
+            "type": "object",
+            "required": ["schema", "summary", "documents", "groups", "indexes"],
+            "properties": {
+                "schema": {
+                    "const": "altium-toolkit.project.document-graph.a1"
+                },
+                "summary": {
+                    "type": "object",
+                    "additionalProperties": true
+                },
+                "documents": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "groups": {
+                    "type": "object",
+                    "additionalProperties": true
+                },
+                "indexes": {
+                    "type": "object",
+                    "additionalProperties": true
+                }
+            },
+            "additionalProperties": true
+        },
+        "projectOutJobDigest": {
+            "type": "object",
+            "required": [
+                "schema",
+                "summary",
+                "documents",
+                "outputGroups",
+                "expectedArtifacts",
+                "outputsByDocumentPath"
+            ],
+            "properties": {
+                "schema": {
+                    "const": "altium-toolkit.project.outjob-digest.a1"
+                },
+                "summary": {
+                    "type": "object",
+                    "additionalProperties": true
+                },
+                "documents": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "outputGroups": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "expectedArtifacts": {
+                    "type": "object",
+                    "additionalProperties": true
+                },
+                "outputsByDocumentPath": {
+                    "type": "object",
+                    "additionalProperties": true
+                }
+            },
+            "additionalProperties": true
+        },
+        "draftsmanDigest": {
+            "type": "object",
+            "required": ["schema", "pages"],
+            "properties": {
+                "schema": {
+                    "const": "altium-toolkit.draftsman.digest.a1"
+                },
+                "sourceDocumentName": {
+                    "type": "string"
+                },
+                "pages": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "styles": {
+                    "type": "object",
+                    "additionalProperties": true
+                },
+                "boardViewMetadata": {
+                    "$ref": "#/$defs/draftsmanBoardViewCache"
+                },
+                "indexes": {
+                    "type": "object",
+                    "additionalProperties": true
+                }
+            },
+            "additionalProperties": true
+        },
+        "draftsmanBoardViewCache": {
+            "type": "object",
+            "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
+                    }
+                }
+            },
+            "additionalProperties": true
+        },
         "schematicRenderDiagnostics": {
             "type": "object",
             "required": ["schema", "fontFallbacks"],
@@ -617,6 +930,39 @@
                 },
                 "extendedPrimitiveInformation": {
                     "$ref": "#/$defs/pcbExtendedPrimitiveInformationEntry"
+                },
+                "localStack": {
+                    "$ref": "#/$defs/pcbPadLocalStack"
+                }
+            },
+            "additionalProperties": true
+        },
+        "pcbPadLocalStack": {
+            "type": "object",
+            "required": ["schema", "mode", "modeName", "source", "layers"],
+            "properties": {
+                "schema": {
+                    "const": "altium-toolkit.pcb.pad-local-stack.a1"
+                },
+                "mode": {
+                    "type": "number"
+                },
+                "modeName": {
+                    "type": "string"
+                },
+                "source": {
+                    "type": "string"
+                },
+                "layers": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "hole": {
+                    "type": "object",
+                    "additionalProperties": true
                 }
             },
             "additionalProperties": true
@@ -1185,25 +1531,60 @@
                 "height": {
                     "type": ["number", "null"]
                 },
+                "componentKind": {
+                    "$ref": "#/$defs/componentKindPolicy"
+                },
                 "provenance": {
                     "$ref": "#/$defs/pcbComponentProvenance"
                 }
             },
             "additionalProperties": true
         },
-        "pcbComponentProvenance": {
+        "componentKindPolicy": {
             "type": "object",
+            "required": [
+                "value",
+                "name",
+                "displayName",
+                "includeInBom",
+                "includeInNetlist",
+                "includeInPnp"
+            ],
             "properties": {
-                "channelOffset": {
+                "value": {
                     "type": "number"
                 },
-                "sourceDesignator": {
+                "name": {
                     "type": "string"
                 },
-                "sourceUniqueId": {
+                "displayName": {
                     "type": "string"
                 },
-                "sourceUniqueIdSegments": {
+                "includeInBom": {
+                    "type": "boolean"
+                },
+                "includeInNetlist": {
+                    "type": "boolean"
+                },
+                "includeInPnp": {
+                    "type": "boolean"
+                }
+            },
+            "additionalProperties": true
+        },
+        "pcbComponentProvenance": {
+            "type": "object",
+            "properties": {
+                "channelOffset": {
+                    "type": "number"
+                },
+                "sourceDesignator": {
+                    "type": "string"
+                },
+                "sourceUniqueId": {
+                    "type": "string"
+                },
+                "sourceUniqueIdSegments": {
                     "type": "array",
                     "items": {
                         "type": "string"
@@ -1446,6 +1827,9 @@
             "type": "object",
             "required": ["positionMode", "entries", "modes"],
             "properties": {
+                "units": {
+                    "$ref": "#/$defs/units"
+                },
                 "positionMode": {
                     "enum": ["altium-pick-place", "component-origin"]
                 },
@@ -1462,6 +1846,9 @@
                             "type": "object",
                             "required": ["positionMode", "entries"],
                             "properties": {
+                                "units": {
+                                    "$ref": "#/$defs/units"
+                                },
                                 "positionMode": {
                                     "const": "component-origin"
                                 },
@@ -1524,6 +1911,9 @@
                 },
                 "positionSource": {
                     "type": "string"
+                },
+                "componentKind": {
+                    "$ref": "#/$defs/componentKindPolicy"
                 }
             },
             "additionalProperties": true
@@ -1657,6 +2047,252 @@
                 "additionalProperties": true
             }
         },
+        "pcbBomProfile": {
+            "type": "object",
+            "required": [
+                "schema",
+                "source",
+                "summary",
+                "groups",
+                "components",
+                "exclusions"
+            ],
+            "properties": {
+                "schema": {
+                    "const": "altium-toolkit.pcb.bom-profile.a1"
+                },
+                "source": {
+                    "type": "string"
+                },
+                "summary": {
+                    "type": "object",
+                    "additionalProperties": true
+                },
+                "groups": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "components": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "exclusions": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                }
+            },
+            "additionalProperties": true
+        },
+        "pcbLayerStackReadModel": {
+            "type": "object",
+            "required": [
+                "schema",
+                "summary",
+                "source",
+                "layers",
+                "substacks",
+                "branches",
+                "impedanceProfiles",
+                "transmissionLines",
+                "viaSpans",
+                "backdrillSpans",
+                "diagnostics"
+            ],
+            "properties": {
+                "schema": {
+                    "const": "altium-toolkit.pcb.layer-stack.a1"
+                },
+                "summary": {
+                    "type": "object",
+                    "additionalProperties": true
+                },
+                "source": {
+                    "type": "object",
+                    "additionalProperties": true
+                },
+                "layers": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "substacks": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "branches": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "impedanceProfiles": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "transmissionLines": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "viaSpans": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "backdrillSpans": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "fidelityReport": {
+                    "$ref": "#/$defs/pcbLayerStackFidelityReport"
+                },
+                "diagnostics": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                }
+            },
+            "additionalProperties": true
+        },
+        "pcbLayerStackFidelityReport": {
+            "type": "object",
+            "required": [
+                "schema",
+                "sourceDocument",
+                "summary",
+                "capabilities",
+                "semanticSections",
+                "nativeCacheSections",
+                "interchangeOnlySections",
+                "unsupportedRegeneration",
+                "diagnostics"
+            ],
+            "properties": {
+                "schema": {
+                    "const": "altium-toolkit.pcb.layer-stack-fidelity.a1"
+                },
+                "sourceDocument": {
+                    "type": "string"
+                },
+                "summary": {
+                    "type": "object",
+                    "additionalProperties": true
+                },
+                "capabilities": {
+                    "type": "object",
+                    "additionalProperties": true
+                },
+                "semanticSections": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "nativeCacheSections": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "interchangeOnlySections": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "unsupportedRegeneration": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "diagnostics": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                }
+            },
+            "additionalProperties": true
+        },
+        "pcbRigidFlexTopology": {
+            "type": "object",
+            "required": [
+                "schema",
+                "summary",
+                "substackRegionJoins",
+                "branchGraph",
+                "bendLines",
+                "diagnostics"
+            ],
+            "properties": {
+                "schema": {
+                    "const": "altium-toolkit.pcb.rigid-flex-topology.a1"
+                },
+                "summary": {
+                    "type": "object",
+                    "additionalProperties": true
+                },
+                "substackRegionJoins": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "branchGraph": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "bendLines": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "diagnostics": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                }
+            },
+            "additionalProperties": true
+        },
         "embeddedFonts": {
             "type": "array",
             "items": {
@@ -1934,6 +2570,9 @@
                 "schema": {
                     "const": "altium-toolkit.pcb.statistics.a1"
                 },
+                "units": {
+                    "$ref": "#/$defs/units"
+                },
                 "board": {
                     "type": "object",
                     "additionalProperties": true
@@ -1957,6 +2596,195 @@
             },
             "additionalProperties": true
         },
+        "pcbRouteAnalysis": {
+            "type": "object",
+            "required": ["schema", "units", "summary", "byNet"],
+            "properties": {
+                "schema": {
+                    "const": "altium-toolkit.pcb.route-analysis.a1"
+                },
+                "units": {
+                    "$ref": "#/$defs/units"
+                },
+                "summary": {
+                    "type": "object",
+                    "additionalProperties": true
+                },
+                "byNet": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "classes": {
+                    "type": "array"
+                },
+                "differentialPairs": {
+                    "type": "array"
+                }
+            },
+            "additionalProperties": true
+        },
+        "pcbReviewMetadata": {
+            "type": "object",
+            "required": [
+                "schema",
+                "summary",
+                "routeGroups",
+                "routeHighlightProfiles",
+                "polygonRealizations",
+                "drillReview",
+                "boardAssemblyViews",
+                "indexes"
+            ],
+            "properties": {
+                "schema": {
+                    "const": "altium-toolkit.pcb.review-metadata.a1"
+                },
+                "summary": {
+                    "type": "object",
+                    "additionalProperties": true
+                },
+                "routeGroups": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "routeHighlightProfiles": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "polygonRealizations": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "drillReview": {
+                    "type": "object",
+                    "additionalProperties": true
+                },
+                "boardAssemblyViews": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "indexes": {
+                    "type": "object",
+                    "additionalProperties": true
+                }
+            },
+            "additionalProperties": true
+        },
+        "pcbPlacedFootprintExtraction": {
+            "type": "object",
+            "required": [
+                "schema",
+                "sourceDocument",
+                "summary",
+                "outputs",
+                "indexes"
+            ],
+            "properties": {
+                "schema": {
+                    "const": "altium-toolkit.pcb.placed-footprint-extraction.a1"
+                },
+                "sourceDocument": {
+                    "type": "string"
+                },
+                "summary": {
+                    "type": "object",
+                    "additionalProperties": true
+                },
+                "outputs": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                },
+                "indexes": {
+                    "type": "object",
+                    "additionalProperties": true
+                }
+            },
+            "additionalProperties": true
+        },
+        "projectBomPnpReconciliation": {
+            "type": "object",
+            "required": [
+                "schema",
+                "summary",
+                "schematicBomDesignators",
+                "pcbBomDesignators",
+                "pnpDesignators",
+                "effectiveBomDesignators",
+                "noBomDesignators",
+                "issues"
+            ],
+            "properties": {
+                "schema": {
+                    "const": "altium-toolkit.project.bom-pnp-reconciliation.a1"
+                },
+                "summary": {
+                    "type": "object",
+                    "additionalProperties": true
+                },
+                "schematicBomDesignators": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "pcbBomDesignators": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "pnpDesignators": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "effectiveBomDesignators": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "noBomDesignators": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "issues": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                }
+            },
+            "additionalProperties": true
+        },
+        "units": {
+            "type": "object",
+            "additionalProperties": {
+                "type": "string"
+            }
+        },
         "libraryRenderManifest": {
             "type": "object",
             "properties": {
@@ -1983,6 +2811,27 @@
             },
             "additionalProperties": true
         },
+        "pcbLibraryParityReport": {
+            "type": "object",
+            "required": ["schema", "summary", "footprints"],
+            "properties": {
+                "schema": {
+                    "const": "altium-toolkit.pcblib.parity.a1"
+                },
+                "summary": {
+                    "type": "object",
+                    "additionalProperties": true
+                },
+                "footprints": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                }
+            },
+            "additionalProperties": true
+        },
         "libraryIndexes": {
             "type": "object",
             "properties": {