circuitjson-toolkit 1.0.16 → 1.1.0

package/src/core/CircuitJsonDocument.mjs

@@ -1,4 +1,6 @@
 import { CircuitJsonElementValidator } from './CircuitJsonElementValidator.mjs'
+import { CircuitJsonLegacyModel } from './context/CircuitJsonLegacyModel.mjs'
+import { CircuitJsonLegacyNormalizer } from './context/CircuitJsonLegacyNormalizer.mjs'
 
 /**
  * Validates serialized CircuitJSON element arrays.
@@ -25,24 +27,36 @@ export class CircuitJsonDocument {
     /**
      * Returns validation errors for a candidate CircuitJSON element array.
      * @param {unknown} value Candidate model.
+     * @param {{ freeze?: boolean }} [options] Validation options.
      * @returns {string[]}
      */
-    static validateModel(value) {
-        return CircuitJsonElementValidator.validateModel(value)
+    static validateModel(value, options = {}) {
+        return CircuitJsonElementValidator.validateModel(value, options)
     }
 
     /**
      * Throws when a value is not a CircuitJSON element array.
      * @param {unknown} value Candidate model.
+     * @param {{ freeze?: boolean }} [options] Validation options.
      * @returns {void}
      */
-    static assertModel(value) {
-        const errors = CircuitJsonDocument.validateModel(value)
+    static assertModel(value, options = {}) {
+        const errors = CircuitJsonDocument.validateModel(value, options)
         if (errors.length) {
             throw new TypeError(errors[0])
         }
     }
 
+    /**
+     * Projects supported pre-union aliases onto the current CircuitJSON model.
+     * @param {unknown} model CircuitJSON model candidate.
+     * @param {{ owned?: boolean }} [options] Ownership options.
+     * @returns {unknown} Original model or its canonical projection.
+     */
+    static normalizeModel(model, options = {}) {
+        return CircuitJsonLegacyNormalizer.normalize(model, options)
+    }
+
     /**
      * Attaches non-serialized metadata to a CircuitJSON array.
      * @template {object[]} T
@@ -52,62 +66,6 @@ export class CircuitJsonDocument {
      */
     static attachMetadata(circuitJson, metadata = {}) {
         CircuitJsonDocument.assertModel(circuitJson)
-        Object.defineProperties(circuitJson, {
-            fileName: {
-                configurable: true,
-                enumerable: true,
-                value: String(metadata.fileName || ''),
-                writable: true
-            },
-            fileType: {
-                configurable: true,
-                enumerable: true,
-                value: String(metadata.fileType || 'circuitjson'),
-                writable: true
-            },
-            kind: {
-                configurable: true,
-                enumerable: true,
-                value: String(metadata.kind || 'pcb'),
-                writable: true
-            },
-            sourceFormat: {
-                configurable: true,
-                enumerable: true,
-                value: 'circuitjson',
-                writable: true
-            },
-            diagnostics: {
-                configurable: true,
-                enumerable: true,
-                value: Array.isArray(metadata.diagnostics)
-                    ? metadata.diagnostics
-                    : [],
-                writable: true
-            },
-            bom: {
-                configurable: true,
-                enumerable: true,
-                value: Array.isArray(metadata.bom) ? metadata.bom : [],
-                writable: true
-            },
-            supportMatrix: {
-                configurable: true,
-                enumerable: true,
-                value: metadata.supportMatrix || null,
-                writable: true
-            },
-            manufacturing: {
-                configurable: true,
-                enumerable: true,
-                value: metadata.manufacturing || {
-                    pickAndPlaceRows: [],
-                    routingDsn: ''
-                },
-                writable: true
-            }
-        })
-
-        return circuitJson
+        return CircuitJsonLegacyModel.attachValidated(circuitJson, metadata)
     }
 }

package/src/core/CircuitJsonElementTypes.mjs

@@ -0,0 +1,10 @@
+import { CIRCUIT_JSON_UPSTREAM_ELEMENT_TYPES } from './CircuitJsonUpstreamSchema.mjs'
+import { CircuitJsonToolkitElementSchema } from './CircuitJsonToolkitElementSchema.mjs'
+
+/**
+ * Frozen inventory of exact pinned upstream CircuitJSON element type names.
+ */
+export const CIRCUIT_JSON_ELEMENT_TYPES = new Set([
+    ...CIRCUIT_JSON_UPSTREAM_ELEMENT_TYPES,
+    ...CircuitJsonToolkitElementSchema.elementTypes()
+])