altium-toolkit 0.1.0 → 0.1.16

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

@@ -0,0 +1,553 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "urn:altium-toolkit:normalized-model:a1",
+    "$comment": "SPDX-FileCopyrightText: 2026 André Fiedler; SPDX-License-Identifier: CC-BY-SA-4.0",
+    "title": "Altium Toolkit Normalized Model A1",
+    "description": "Root contract for normalized models emitted by Altium Toolkit parser entrypoints.",
+    "type": "object",
+    "required": [
+        "schema",
+        "kind",
+        "fileType",
+        "fileName",
+        "summary",
+        "diagnostics",
+        "bom"
+    ],
+    "properties": {
+        "schema": {
+            "const": "urn:altium-toolkit:normalized-model:a1"
+        },
+        "kind": {
+            "enum": ["schematic", "pcb", "pcb-library", "project"]
+        },
+        "fileType": {
+            "enum": ["SchDoc", "PcbDoc", "PcbLib", "PrjPcb"]
+        },
+        "fileName": {
+            "type": "string"
+        },
+        "summary": {
+            "type": "object",
+            "additionalProperties": {
+                "type": ["number", "string", "boolean", "null"]
+            }
+        },
+        "diagnostics": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "required": ["severity", "message"],
+                "properties": {
+                    "severity": {
+                        "enum": ["info", "warning"]
+                    },
+                    "message": {
+                        "type": "string"
+                    }
+                },
+                "additionalProperties": true
+            }
+        },
+        "schematic": {
+            "type": "object"
+        },
+        "pcb": {
+            "type": "object",
+            "properties": {
+                "components": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/pcbComponent"
+                    }
+                },
+                "embeddedFonts": {
+                    "$ref": "#/$defs/embeddedFonts"
+                },
+                "rawRecords": {
+                    "$ref": "#/$defs/rawRecords"
+                },
+                "layerSubstacks": {
+                    "$ref": "#/$defs/layerSubstacks"
+                },
+                "boardRegionContexts": {
+                    "$ref": "#/$defs/boardRegionContexts"
+                },
+                "componentPrimitives": {
+                    "type": "array",
+                    "items": {
+                        "anyOf": [
+                            {
+                                "$ref": "#/$defs/componentPrimitiveGroup"
+                            },
+                            {
+                                "type": "null"
+                            }
+                        ]
+                    }
+                },
+                "componentPrimitiveGroups": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/componentPrimitiveGroup"
+                    }
+                },
+                "texts": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/pcbText"
+                    }
+                }
+            },
+            "additionalProperties": true
+        },
+        "pcbLibrary": {
+            "type": "object",
+            "properties": {
+                "embeddedFonts": {
+                    "$ref": "#/$defs/embeddedFonts"
+                },
+                "footprints": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "properties": {
+                            "rawRecords": {
+                                "$ref": "#/$defs/rawRecords"
+                            }
+                        },
+                        "additionalProperties": true
+                    }
+                }
+            },
+            "additionalProperties": true
+        },
+        "project": {
+            "type": "object"
+        },
+        "bom": {
+            "type": "array",
+            "items": {
+                "type": "object"
+            }
+        }
+    },
+    "oneOf": [
+        {
+            "required": ["schematic"],
+            "properties": {
+                "kind": {
+                    "const": "schematic"
+                },
+                "fileType": {
+                    "const": "SchDoc"
+                }
+            }
+        },
+        {
+            "required": ["pcb"],
+            "properties": {
+                "kind": {
+                    "const": "pcb"
+                },
+                "fileType": {
+                    "const": "PcbDoc"
+                }
+            }
+        },
+        {
+            "required": ["pcbLibrary"],
+            "properties": {
+                "kind": {
+                    "const": "pcb-library"
+                },
+                "fileType": {
+                    "const": "PcbLib"
+                }
+            }
+        },
+        {
+            "required": ["project"],
+            "properties": {
+                "kind": {
+                    "const": "project"
+                },
+                "fileType": {
+                    "const": "PrjPcb"
+                }
+            }
+        }
+    ],
+    "$defs": {
+        "rawRecords": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "required": [
+                    "registryId",
+                    "source",
+                    "sourceStream",
+                    "family",
+                    "type",
+                    "recordIndex",
+                    "offset",
+                    "byteLength",
+                    "encoding",
+                    "supported",
+                    "parsed",
+                    "rawBase64"
+                ],
+                "properties": {
+                    "registryId": {
+                        "type": "string"
+                    },
+                    "source": {
+                        "enum": ["pcbdoc", "pcblib"]
+                    },
+                    "sourceStorage": {
+                        "type": "string"
+                    },
+                    "sourceStream": {
+                        "type": "string"
+                    },
+                    "headerStream": {
+                        "type": "string"
+                    },
+                    "family": {
+                        "type": "string"
+                    },
+                    "type": {
+                        "type": "string"
+                    },
+                    "typeId": {
+                        "type": ["number", "null"]
+                    },
+                    "recordIndex": {
+                        "type": "number"
+                    },
+                    "offset": {
+                        "type": "number"
+                    },
+                    "byteLength": {
+                        "type": "number"
+                    },
+                    "payloadByteLength": {
+                        "type": ["number", "null"]
+                    },
+                    "encoding": {
+                        "type": "string"
+                    },
+                    "supported": {
+                        "type": "boolean"
+                    },
+                    "parsed": {
+                        "type": "boolean"
+                    },
+                    "rawBase64": {
+                        "type": "string"
+                    }
+                },
+                "additionalProperties": true
+            }
+        },
+        "pcbComponent": {
+            "type": "object",
+            "required": [
+                "componentIndex",
+                "designator",
+                "x",
+                "y",
+                "layer",
+                "pattern",
+                "rotation",
+                "source",
+                "description",
+                "height"
+            ],
+            "properties": {
+                "componentIndex": {
+                    "type": "number"
+                },
+                "designator": {
+                    "type": "string"
+                },
+                "baseDesignator": {
+                    "type": "string"
+                },
+                "displayDesignator": {
+                    "type": "string"
+                },
+                "designatorSource": {
+                    "const": "Texts6/Data"
+                },
+                "uniqueId": {
+                    "type": "string"
+                },
+                "parameters": {
+                    "type": "object",
+                    "additionalProperties": {
+                        "type": "string"
+                    }
+                },
+                "parameterSource": {
+                    "const": "PrimitiveParameters/Data"
+                },
+                "x": {
+                    "type": "number"
+                },
+                "y": {
+                    "type": "number"
+                },
+                "layer": {
+                    "type": "string"
+                },
+                "pattern": {
+                    "type": "string"
+                },
+                "rotation": {
+                    "type": "number"
+                },
+                "source": {
+                    "type": "string"
+                },
+                "description": {
+                    "type": "string"
+                },
+                "height": {
+                    "type": ["number", "null"]
+                }
+            },
+            "additionalProperties": true
+        },
+        "pcbText": {
+            "type": "object",
+            "properties": {
+                "text": {
+                    "type": "string"
+                },
+                "textSource": {
+                    "const": "WideStrings6/Data"
+                },
+                "role": {
+                    "type": "string"
+                },
+                "isDesignator": {
+                    "type": "boolean"
+                },
+                "isComment": {
+                    "type": "boolean"
+                },
+                "isPlaceholder": {
+                    "type": "boolean"
+                },
+                "componentIndex": {
+                    "type": ["number", "null"]
+                },
+                "embeddedFontIndex": {
+                    "type": "number"
+                },
+                "fontMetrics": {
+                    "type": "object",
+                    "additionalProperties": {
+                        "type": ["number", "string", "boolean", "null"]
+                    }
+                }
+            },
+            "additionalProperties": true
+        },
+        "layerSubstacks": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "required": ["index", "fieldFamily", "id", "name"],
+                "properties": {
+                    "index": {
+                        "type": "number"
+                    },
+                    "fieldFamily": {
+                        "type": "string"
+                    },
+                    "id": {
+                        "type": "string"
+                    },
+                    "name": {
+                        "type": "string"
+                    },
+                    "isFlex": {
+                        "type": ["boolean", "null"]
+                    },
+                    "showTopDielectric": {
+                        "type": ["boolean", "null"]
+                    },
+                    "showBottomDielectric": {
+                        "type": ["boolean", "null"]
+                    },
+                    "serviceStackup": {
+                        "type": ["boolean", "null"]
+                    },
+                    "usedByPrimitives": {
+                        "type": ["boolean", "null"]
+                    },
+                    "rawStackupType": {
+                        "type": "string"
+                    }
+                },
+                "additionalProperties": true
+            }
+        },
+        "boardRegionContexts": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "required": [
+                    "regionIndex",
+                    "name",
+                    "layerStackId",
+                    "substackIndex",
+                    "substackName",
+                    "isFlex",
+                    "locked3d",
+                    "bendingLineCount"
+                ],
+                "properties": {
+                    "regionIndex": {
+                        "type": "number"
+                    },
+                    "name": {
+                        "type": "string"
+                    },
+                    "layerStackId": {
+                        "type": "string"
+                    },
+                    "substackIndex": {
+                        "type": ["number", "null"]
+                    },
+                    "substackName": {
+                        "type": "string"
+                    },
+                    "isFlex": {
+                        "type": ["boolean", "null"]
+                    },
+                    "locked3d": {
+                        "type": "boolean"
+                    },
+                    "bendingLineCount": {
+                        "type": "number"
+                    }
+                },
+                "additionalProperties": true
+            }
+        },
+        "embeddedFonts": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "required": [
+                    "index",
+                    "name",
+                    "style",
+                    "fileName",
+                    "sourceStream",
+                    "format",
+                    "mimeType",
+                    "byteCount",
+                    "compressedByteCount",
+                    "payloadBase64",
+                    "metrics"
+                ],
+                "properties": {
+                    "index": {
+                        "type": "number"
+                    },
+                    "name": {
+                        "type": "string"
+                    },
+                    "style": {
+                        "type": "string"
+                    },
+                    "fileName": {
+                        "type": "string"
+                    },
+                    "sourceStream": {
+                        "type": "string"
+                    },
+                    "format": {
+                        "enum": ["truetype", "opentype", "unknown"]
+                    },
+                    "mimeType": {
+                        "type": "string"
+                    },
+                    "byteCount": {
+                        "type": "number"
+                    },
+                    "compressedByteCount": {
+                        "type": "number"
+                    },
+                    "payloadBase64": {
+                        "type": "string"
+                    },
+                    "metrics": {
+                        "type": "object",
+                        "additionalProperties": {
+                            "type": ["number", "string", "boolean", "null"]
+                        }
+                    }
+                },
+                "additionalProperties": true
+            }
+        },
+        "componentPrimitiveGroup": {
+            "type": "object",
+            "required": [
+                "componentIndex",
+                "designator",
+                "pads",
+                "tracks",
+                "arcs",
+                "fills",
+                "vias",
+                "regions",
+                "shapeBasedRegions",
+                "texts",
+                "componentBodies"
+            ],
+            "properties": {
+                "componentIndex": {
+                    "type": "number"
+                },
+                "designator": {
+                    "type": "string"
+                },
+                "pads": {
+                    "type": "array"
+                },
+                "tracks": {
+                    "type": "array"
+                },
+                "arcs": {
+                    "type": "array"
+                },
+                "fills": {
+                    "type": "array"
+                },
+                "vias": {
+                    "type": "array"
+                },
+                "regions": {
+                    "type": "array"
+                },
+                "shapeBasedRegions": {
+                    "type": "array"
+                },
+                "texts": {
+                    "type": "array"
+                },
+                "componentBodies": {
+                    "type": "array"
+                }
+            },
+            "additionalProperties": true
+        }
+    },
+    "additionalProperties": true
+}

package/docs/testing.md

@@ -15,9 +15,14 @@ npm test
 The tests cover:
 
 - Binary and OLE helpers
-- Printable and binary Altium parser recovery
+- Printable and binary Altium parser recovery for `.SchDoc`, `.PcbDoc`,
+  `.PcbLib`, and `.PrjPcb` entrypoints
+- PCB primitive stream slicing and focused decoders for tracks, fills, arcs,
+  vias, pads, text, regions, rules, raw records, board regions, ownership
+  indexes, sidecar PrimitiveParameters/Text tables, and embedded font metadata
 - Obfuscated fake schematic and PCB fixture shards
-- Schematic SVG, PCB SVG, BOM HTML, and static 3D summary renderers
+- Schematic SVG, side-resolved PCB SVG, BOM HTML, and static 3D summary
+  renderers
 - Non-interactive PCB 3D scene-description builders and model registry logic
 
 Fixture data must remain repo-owned and obfuscated. Do not add native provided

package/package.json

@@ -1,7 +1,22 @@
 {
     "name": "altium-toolkit",
-    "version": "0.1.0",
+    "version": "0.1.16",
     "description": "Altium document parsing and non-interactive rendering utilities",
+    "keywords": [
+        "altium",
+        "altium-designer",
+        "schdoc",
+        "pcbdoc",
+        "ecad",
+        "eda",
+        "pcb",
+        "schematic",
+        "parser",
+        "renderer",
+        "svg",
+        "bom",
+        "3d"
+    ],
     "license": "GPL-3.0-or-later",
     "type": "module",
     "main": "./src/index.mjs",
@@ -16,6 +31,10 @@
     "files": [
         "src",
         "docs",
+        "!docs/.superpowers",
+        "!docs/.superpowers/**",
+        "!docs/superpowers",
+        "!docs/superpowers/**",
         "examples",
         "spec",
         "LICENSE",
@@ -34,7 +53,7 @@
     },
     "dependencies": {
         "fflate": "^0.8.2",
-        "three": "^0.183.2"
+        "three": "^0.184.0"
     },
     "devDependencies": {
         "prettier": "^3.4.2"

package/spec/library-scope.md

@@ -11,15 +11,21 @@ rendering primitives.
 
 ## In Scope
 
-- `.SchDoc` and `.PcbDoc` parsing from `ArrayBuffer`
+- `.SchDoc`, `.PcbDoc`, `.PcbLib`, and `.PrjPcb` parsing from `ArrayBuffer`
 - OLE and binary stream helpers needed by parser recovery
 - Schematic SVG rendering
 - PCB SVG rendering
 - BOM HTML rendering
 - PCB 3D scene-description data
+- Embedded PCB/PcbLib font extraction and basic text metrics for deterministic
+  SVG rendering
+- Read-only PCB primitive record registry metadata and base64 raw-record
+  preservation for unsupported or partially decoded PcbDoc/PcbLib streams
 - Static 3D summary HTML
 - Parser worker entrypoint for host applications
 - Optional renderer CSS
+- Versioned normalized model schema identifiers and machine-readable schema
+  contracts
 
 ## Out Of Scope