kicadts 0.0.1 → 0.0.2

package/lib/sexpr/classes/Footprint.ts

@@ -1,7 +1,7 @@
 import { SxClass } from "../base-classes/SxClass"
 import type { PrimitiveSExpr } from "../parseToPrimitiveSExpr"
 import { quoteSExprString } from "../utils/quoteSExprString"
-import { At } from "./At"
+import { At, type AtInput } from "./At"
 import { FootprintAttr } from "./FootprintAttr"
 import { FootprintAutoplaceCost180 } from "./FootprintAutoplaceCost180"
 import { FootprintAutoplaceCost90 } from "./FootprintAutoplaceCost90"
@@ -80,6 +80,43 @@ const MULTI_TOKENS = new Set([
 
 const SUPPORTED_TOKENS = new Set([...SINGLE_TOKENS, ...MULTI_TOKENS])
 
+export interface FootprintConstructorParams {
+  libraryLink?: string
+  locked?: boolean
+  placed?: boolean
+  layer?: Layer | string | string[]
+  uuid?: Uuid | string
+  at?: AtInput | Xy
+  descr?: string | FootprintDescr
+  tags?: string | string[] | FootprintTags
+  path?: string | FootprintPath
+  autoplaceCost90?: number | FootprintAutoplaceCost90
+  autoplaceCost180?: number | FootprintAutoplaceCost180
+  solderMaskMargin?: number | FootprintSolderMaskMargin
+  solderPasteMargin?: number | FootprintSolderPasteMargin
+  solderPasteRatio?: number | FootprintSolderPasteRatio
+  clearance?: number | FootprintClearance
+  zoneConnect?: number | FootprintZoneConnect
+  thermalWidth?: number | FootprintThermalWidth
+  thermalGap?: number | FootprintThermalGap
+  attr?: FootprintAttr
+  privateLayers?: FootprintPrivateLayers
+  netTiePadGroups?: FootprintNetTiePadGroups
+  sheetname?: string | FootprintSheetname
+  sheetfile?: string | FootprintSheetfile
+  embeddedFonts?: EmbeddedFonts
+  properties?: Property[]
+  fpTexts?: FpText[]
+  fpTextBoxes?: FpTextBox[]
+  fpLines?: FpLine[]
+  fpRects?: FpRect[]
+  fpCircles?: FpCircle[]
+  fpArcs?: FpArc[]
+  fpPolys?: FpPoly[]
+  pads?: FootprintPad[]
+  models?: FootprintModel[]
+}
+
 export class Footprint extends SxClass {
   static override token = "footprint"
   token = "footprint"
@@ -87,7 +124,7 @@ export class Footprint extends SxClass {
   private _libraryLink?: string
   private _sxLocked?: FootprintLocked
   private _sxPlaced?: FootprintPlaced
-  
+
   private _sxLayer?: Layer
   private _sxTedit?: FootprintTedit
   private _sxUuid?: Uuid
@@ -123,6 +160,53 @@ export class Footprint extends SxClass {
   private _fpPads: FootprintPad[] = []
   private _models: FootprintModel[] = []
 
+  constructor(params: FootprintConstructorParams = {}) {
+    super()
+    if (params.libraryLink !== undefined) this.libraryLink = params.libraryLink
+    if (params.locked !== undefined) this.locked = params.locked
+    if (params.placed !== undefined) this.placed = params.placed
+    if (params.layer !== undefined) this.layer = params.layer
+    if (params.uuid !== undefined) this.uuid = params.uuid
+    if (params.at !== undefined) this.position = params.at
+    if (params.descr !== undefined) this.descr = params.descr
+    if (params.tags !== undefined) this.tags = params.tags
+    if (params.path !== undefined) this.path = params.path
+    if (params.autoplaceCost90 !== undefined)
+      this.autoplaceCost90 = params.autoplaceCost90
+    if (params.autoplaceCost180 !== undefined)
+      this.autoplaceCost180 = params.autoplaceCost180
+    if (params.solderMaskMargin !== undefined)
+      this.solderMaskMargin = params.solderMaskMargin
+    if (params.solderPasteMargin !== undefined)
+      this.solderPasteMargin = params.solderPasteMargin
+    if (params.solderPasteRatio !== undefined)
+      this.solderPasteRatio = params.solderPasteRatio
+    if (params.clearance !== undefined) this.clearance = params.clearance
+    if (params.zoneConnect !== undefined) this.zoneConnect = params.zoneConnect
+    if (params.thermalWidth !== undefined)
+      this.thermalWidth = params.thermalWidth
+    if (params.thermalGap !== undefined) this.thermalGap = params.thermalGap
+    if (params.attr !== undefined) this.attr = params.attr
+    if (params.privateLayers !== undefined)
+      this.privateLayers = params.privateLayers
+    if (params.netTiePadGroups !== undefined)
+      this.netTiePadGroups = params.netTiePadGroups
+    if (params.sheetname !== undefined) this.sheetname = params.sheetname
+    if (params.sheetfile !== undefined) this.sheetfile = params.sheetfile
+    if (params.embeddedFonts !== undefined)
+      this.embeddedFonts = params.embeddedFonts
+    if (params.properties !== undefined) this.properties = params.properties
+    if (params.fpTexts !== undefined) this.fpTexts = params.fpTexts
+    if (params.fpTextBoxes !== undefined) this.fpTextBoxes = params.fpTextBoxes
+    if (params.fpLines !== undefined) this.fpLines = params.fpLines
+    if (params.fpRects !== undefined) this.fpRects = params.fpRects
+    if (params.fpCircles !== undefined) this.fpCircles = params.fpCircles
+    if (params.fpArcs !== undefined) this.fpArcs = params.fpArcs
+    if (params.fpPolys !== undefined) this.fpPolys = params.fpPolys
+    if (params.pads !== undefined) this.fpPads = params.pads
+    if (params.models !== undefined) this.models = params.models
+  }
+
   static override fromSexprPrimitives(
     primitiveSexprs: PrimitiveSExpr[],
   ): Footprint {
@@ -156,16 +240,22 @@ export class Footprint extends SxClass {
 
     for (const token of Object.keys(propertyMap)) {
       if (!SUPPORTED_TOKENS.has(token)) {
-        throw new Error(`footprint encountered unsupported child token "${token}"`)
+        throw new Error(
+          `footprint encountered unsupported child token "${token}"`,
+        )
       }
     }
 
     for (const [token, entries] of Object.entries(arrayPropertyMap)) {
       if (!SUPPORTED_TOKENS.has(token)) {
-        throw new Error(`footprint encountered unsupported child token "${token}"`)
+        throw new Error(
+          `footprint encountered unsupported child token "${token}"`,
+        )
       }
       if (!MULTI_TOKENS.has(token) && entries.length > 1) {
-        throw new Error(`footprint does not support repeated child token "${token}"`)
+        throw new Error(
+          `footprint does not support repeated child token "${token}"`,
+        )
       }
     }
 
@@ -203,14 +293,18 @@ export class Footprint extends SxClass {
     footprint._sxSolderPasteRatio = propertyMap.solder_paste_ratio as
       | FootprintSolderPasteRatio
       | undefined
-    footprint._sxClearance = propertyMap.clearance as FootprintClearance | undefined
+    footprint._sxClearance = propertyMap.clearance as
+      | FootprintClearance
+      | undefined
     footprint._sxZoneConnect = propertyMap.zone_connect as
       | FootprintZoneConnect
       | undefined
     footprint._sxThermalWidth = propertyMap.thermal_width as
       | FootprintThermalWidth
       | undefined
-    footprint._sxThermalGap = propertyMap.thermal_gap as FootprintThermalGap | undefined
+    footprint._sxThermalGap = propertyMap.thermal_gap as
+      | FootprintThermalGap
+      | undefined
     footprint._sxAttr = propertyMap.attr as FootprintAttr | undefined
     footprint._sxPrivateLayers = propertyMap.private_layers as
       | FootprintPrivateLayers
@@ -218,9 +312,15 @@ export class Footprint extends SxClass {
     footprint._sxNetTiePadGroups = propertyMap.net_tie_pad_groups as
       | FootprintNetTiePadGroups
       | undefined
-    footprint._sxSheetname = propertyMap.sheetname as FootprintSheetname | undefined
-    footprint._sxSheetfile = propertyMap.sheetfile as FootprintSheetfile | undefined
-    footprint._sxEmbeddedFonts = propertyMap.embedded_fonts as EmbeddedFonts | undefined
+    footprint._sxSheetname = propertyMap.sheetname as
+      | FootprintSheetname
+      | undefined
+    footprint._sxSheetfile = propertyMap.sheetfile as
+      | FootprintSheetfile
+      | undefined
+    footprint._sxEmbeddedFonts = propertyMap.embedded_fonts as
+      | EmbeddedFonts
+      | undefined
 
     footprint._properties = (arrayPropertyMap.property as Property[]) ?? []
     footprint._fpTexts = (arrayPropertyMap["fp_text"] as FpText[]) ?? []
@@ -321,7 +421,8 @@ export class Footprint extends SxClass {
       this._sxTedit = undefined
       return
     }
-    this._sxTedit = value instanceof FootprintTedit ? value : new FootprintTedit(value)
+    this._sxTedit =
+      value instanceof FootprintTedit ? value : new FootprintTedit(value)
   }
 
   get uuid(): Uuid | undefined {
@@ -340,9 +441,9 @@ export class Footprint extends SxClass {
     return this._sxAt ?? this._sxXy
   }
 
-  set position(value: At | Xy | undefined) {
-    if (value instanceof At) {
-      this._sxAt = value
+  set position(value: AtInput | Xy | undefined) {
+    if (value === undefined) {
+      this._sxAt = undefined
       this._sxXy = undefined
       return
     }
@@ -351,7 +452,8 @@ export class Footprint extends SxClass {
       this._sxAt = undefined
       return
     }
-    this._sxAt = undefined
+    // Handle AtInput (At, array, or object)
+    this._sxAt = At.from(value as AtInput)
     this._sxXy = undefined
   }
 
@@ -364,19 +466,25 @@ export class Footprint extends SxClass {
       this._sxDescr = undefined
       return
     }
-    this._sxDescr = value instanceof FootprintDescr ? value : new FootprintDescr(value)
+    this._sxDescr =
+      value instanceof FootprintDescr ? value : new FootprintDescr(value)
   }
 
   get tags(): FootprintTags | undefined {
     return this._sxTags
   }
 
-  set tags(value: FootprintTags | string | undefined) {
+  set tags(value: string | string[] | FootprintTags | undefined) {
     if (value === undefined) {
       this._sxTags = undefined
       return
     }
-    this._sxTags = value instanceof FootprintTags ? value : new FootprintTags(value)
+    if (value instanceof FootprintTags) {
+      this._sxTags = value
+      return
+    }
+    const tagString = Array.isArray(value) ? value.join(" ") : value
+    this._sxTags = new FootprintTags(tagString)
   }
 
   get path(): FootprintPath | undefined {
@@ -388,7 +496,8 @@ export class Footprint extends SxClass {
       this._sxPath = undefined
       return
     }
-    this._sxPath = value instanceof FootprintPath ? value : new FootprintPath(value)
+    this._sxPath =
+      value instanceof FootprintPath ? value : new FootprintPath(value)
   }
 
   get autoplaceCost90(): FootprintAutoplaceCost90 | undefined {
@@ -440,7 +549,10 @@ export class Footprint extends SxClass {
     return this._sxSolderPasteMargin
   }
 
-  set solderPasteMargin(value: FootprintSolderPasteMargin | number | undefined) {
+  set solderPasteMargin(value:
+    | FootprintSolderPasteMargin
+    | number
+    | undefined) {
     if (value === undefined) {
       this._sxSolderPasteMargin = undefined
       return
@@ -476,7 +588,9 @@ export class Footprint extends SxClass {
       return
     }
     this._sxClearance =
-      value instanceof FootprintClearance ? value : new FootprintClearance(value)
+      value instanceof FootprintClearance
+        ? value
+        : new FootprintClearance(value)
   }
 
   get zoneConnect(): FootprintZoneConnect | undefined {
@@ -489,7 +603,9 @@ export class Footprint extends SxClass {
       return
     }
     this._sxZoneConnect =
-      value instanceof FootprintZoneConnect ? value : new FootprintZoneConnect(value)
+      value instanceof FootprintZoneConnect
+        ? value
+        : new FootprintZoneConnect(value)
   }
 
   get thermalWidth(): FootprintThermalWidth | undefined {
@@ -517,7 +633,9 @@ export class Footprint extends SxClass {
       return
     }
     this._sxThermalGap =
-      value instanceof FootprintThermalGap ? value : new FootprintThermalGap(value)
+      value instanceof FootprintThermalGap
+        ? value
+        : new FootprintThermalGap(value)
   }
 
   get attr(): FootprintAttr | undefined {
@@ -562,18 +680,30 @@ export class Footprint extends SxClass {
     return this._sxSheetname?.value
   }
 
-  set sheetname(value: string | undefined) {
+  set sheetname(value: string | FootprintSheetname | undefined) {
+    if (value === undefined) {
+      this._sxSheetname = undefined
+      return
+    }
     this._sxSheetname =
-      value === undefined ? undefined : new FootprintSheetname(value)
+      value instanceof FootprintSheetname
+        ? value
+        : new FootprintSheetname(value)
   }
 
   get sheetfile(): string | undefined {
     return this._sxSheetfile?.value
   }
 
-  set sheetfile(value: string | undefined) {
+  set sheetfile(value: string | FootprintSheetfile | undefined) {
+    if (value === undefined) {
+      this._sxSheetfile = undefined
+      return
+    }
     this._sxSheetfile =
-      value === undefined ? undefined : new FootprintSheetfile(value)
+      value instanceof FootprintSheetfile
+        ? value
+        : new FootprintSheetfile(value)
   }
 
   get embeddedFonts(): EmbeddedFonts | undefined {

package/lib/sexpr/classes/FootprintAttr.ts

@@ -35,7 +35,9 @@ export class FootprintAttr extends SxClass {
         attr._type = primitive
         continue
       }
-      throw new Error(`attr encountered duplicate or unknown token "${primitive}"`)
+      throw new Error(
+        `attr encountered duplicate or unknown token "${primitive}"`,
+      )
     }
     return attr
   }

package/lib/sexpr/classes/FootprintModel.ts

@@ -120,10 +120,7 @@ export class FootprintModel extends SxClass {
 }
 SxClass.register(FootprintModel)
 
-function parseVectorArgs(
-  args: PrimitiveSExpr[],
-  token: string,
-): ModelVector {
+function parseVectorArgs(args: PrimitiveSExpr[], token: string): ModelVector {
   if (args.length !== 1) {
     throw new Error(`model ${token} expects a single xyz child`)
   }

package/lib/sexpr/classes/FootprintNetTiePadGroups.ts

@@ -43,7 +43,9 @@ export class FootprintNetTiePadGroups extends SxClass {
   }
 
   override getString(): string {
-    const rendered = this._groups.map((group) => quoteSExprString(group)).join(" ")
+    const rendered = this._groups
+      .map((group) => quoteSExprString(group))
+      .join(" ")
     return `(net_tie_pad_groups ${rendered})`
   }
 }