kicadts 0.0.1 → 0.0.2

package/lib/sexpr/classes/Property.ts

@@ -3,7 +3,7 @@ import type { PrimitiveSExpr } from "../parseToPrimitiveSExpr"
 import { printSExpr } from "../parseToPrimitiveSExpr"
 import { quoteSExprString } from "../utils/quoteSExprString"
 import { toStringValue } from "../utils/toStringValue"
-import { At } from "./At"
+import { At, type AtInput } from "./At"
 import { Layer } from "./Layer"
 import { PropertyHide } from "./PropertyHide"
 import { PropertyUnlocked } from "./PropertyUnlocked"
@@ -31,7 +31,9 @@ const ensureSingleChild = (
   }
 }
 
-const primitiveToString = (value: PrimitiveSExpr | undefined): string | undefined => {
+const primitiveToString = (
+  value: PrimitiveSExpr | undefined,
+): string | undefined => {
   if (value === undefined) {
     return undefined
   }
@@ -42,6 +44,17 @@ const primitiveToString = (value: PrimitiveSExpr | undefined): string | undefine
   return printSExpr(value)
 }
 
+export interface PropertyConstructorParams {
+  key?: string
+  value?: string
+  position?: AtInput | Xy
+  layer?: Layer | Array<string | number> | string
+  uuid?: string | Uuid
+  effects?: TextEffects
+  unlocked?: boolean | PropertyUnlocked
+  hidden?: boolean | PropertyHide
+}
+
 export class Property extends SxClass {
   static override token = "property"
   token = "property"
@@ -56,10 +69,51 @@ export class Property extends SxClass {
   private _sxUnlocked?: PropertyUnlocked
   private _sxHide?: PropertyHide
 
-  constructor(key = "", value = "") {
+  constructor(
+    keyOrParams: string | PropertyConstructorParams = {},
+    value = "",
+  ) {
     super()
-    this._key = key
-    this._value = value
+
+    // Support both old constructor signature and new params interface
+    if (typeof keyOrParams === "string") {
+      this._key = keyOrParams
+      this._value = value
+    } else {
+      const params = keyOrParams
+      if (params.key !== undefined) {
+        this._key = params.key
+      }
+      if (params.value !== undefined) {
+        this._value = params.value
+      }
+      if (params.position !== undefined) {
+        this.position = params.position
+      }
+      if (params.layer !== undefined) {
+        this.layer = params.layer
+      }
+      if (params.uuid !== undefined) {
+        this.uuid = params.uuid
+      }
+      if (params.effects !== undefined) {
+        this.effects = params.effects
+      }
+      if (params.unlocked !== undefined) {
+        if (params.unlocked instanceof PropertyUnlocked) {
+          this._sxUnlocked = params.unlocked
+        } else {
+          this.unlocked = params.unlocked
+        }
+      }
+      if (params.hidden !== undefined) {
+        if (params.hidden instanceof PropertyHide) {
+          this._sxHide = params.hidden
+        } else {
+          this.hidden = params.hidden
+        }
+      }
+    }
   }
 
   static override fromSexprPrimitives(
@@ -152,9 +206,9 @@ export class Property 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
     }
@@ -163,7 +217,8 @@ export class Property 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
   }
 

package/lib/sexpr/classes/Pts.ts

@@ -14,14 +14,14 @@ export class Pts extends SxClass {
     this.points = points
   }
 
-  static override fromSexprPrimitives(
-    primitiveSexprs: PrimitiveSExpr[],
-  ): Pts {
+  static override fromSexprPrimitives(primitiveSexprs: PrimitiveSExpr[]): Pts {
     const points: Xy[] = []
 
     for (const primitive of primitiveSexprs) {
       if (!Array.isArray(primitive) || primitive.length === 0) {
-        throw new Error(`Unexpected primitive inside pts: ${printSExpr(primitive)}`)
+        throw new Error(
+          `Unexpected primitive inside pts: ${printSExpr(primitive)}`,
+        )
       }
 
       const parsed = SxClass.parsePrimitiveSexpr(primitive, {
@@ -39,7 +39,9 @@ export class Pts extends SxClass {
         )
       }
 
-      throw new Error(`Unable to parse child inside pts: ${printSExpr(primitive)}`)
+      throw new Error(
+        `Unable to parse child inside pts: ${printSExpr(primitive)}`,
+      )
     }
 
     return new Pts(points)

package/lib/sexpr/classes/SchematicText.ts

@@ -2,17 +2,20 @@ import { SxClass } from "../base-classes/SxClass"
 import type { PrimitiveSExpr } from "../parseToPrimitiveSExpr"
 import { quoteSExprString } from "../utils/quoteSExprString"
 import { toStringValue } from "../utils/toStringValue"
-import { At } from "./At"
+import { At, type AtInput } from "./At"
 import { ExcludeFromSim } from "./ExcludeFromSim"
 import { TextEffects } from "./TextEffects"
 import { Uuid } from "./Uuid"
 
-const SUPPORTED_TOKENS = new Set([
-  "exclude_from_sim",
-  "at",
-  "effects",
-  "uuid",
-])
+const SUPPORTED_TOKENS = new Set(["exclude_from_sim", "at", "effects", "uuid"])
+
+export interface SchematicTextConstructorParams {
+  value?: string
+  excludeFromSim?: boolean | ExcludeFromSim
+  at?: AtInput
+  effects?: TextEffects
+  uuid?: string | Uuid
+}
 
 export class SchematicText extends SxClass {
   static override token = "text"
@@ -25,6 +28,33 @@ export class SchematicText extends SxClass {
   private _sxEffects?: TextEffects
   private _sxUuid?: Uuid
 
+  constructor(params: SchematicTextConstructorParams = {}) {
+    super()
+
+    if (params.value !== undefined) {
+      this.value = params.value
+    }
+
+    if (params.excludeFromSim !== undefined) {
+      this.excludeFromSim =
+        typeof params.excludeFromSim === "boolean"
+          ? params.excludeFromSim
+          : params.excludeFromSim.value
+    }
+
+    if (params.at !== undefined) {
+      this.at = params.at
+    }
+
+    if (params.effects !== undefined) {
+      this.effects = params.effects
+    }
+
+    if (params.uuid !== undefined) {
+      this.uuid = params.uuid
+    }
+  }
+
   static override fromSexprPrimitives(
     primitiveSexprs: PrimitiveSExpr[],
   ): SchematicText {
@@ -96,8 +126,8 @@ export class SchematicText extends SxClass {
     return this._sxAt
   }
 
-  set at(value: At | undefined) {
-    this._sxAt = value
+  set at(value: AtInput | undefined) {
+    this._sxAt = value !== undefined ? At.from(value) : undefined
   }
 
   get effects(): TextEffects | undefined {

package/lib/sexpr/classes/Segment.ts

@@ -18,6 +18,16 @@ const SUPPORTED_SINGLE_TOKENS = new Set([
   "locked",
 ])
 
+export interface SegmentConstructorParams {
+  start?: SegmentStart | { x: number; y: number }
+  end?: SegmentEnd | { x: number; y: number }
+  width?: Width | number
+  layer?: Layer | string | Array<string | number>
+  net?: SegmentNet | { id: number; name?: string }
+  uuid?: Uuid | string
+  locked?: boolean
+}
+
 export class Segment extends SxClass {
   static override token = "segment"
   override token = "segment"
@@ -30,6 +40,17 @@ export class Segment extends SxClass {
   private _sxUuid?: Uuid
   private _sxLocked?: SegmentLocked
 
+  constructor(params: SegmentConstructorParams = {}) {
+    super()
+    if (params.start !== undefined) this.start = params.start
+    if (params.end !== undefined) this.end = params.end
+    if (params.width !== undefined) this.width = params.width
+    if (params.layer !== undefined) this.layer = params.layer
+    if (params.net !== undefined) this.net = params.net
+    if (params.uuid !== undefined) this.uuid = params.uuid
+    if (params.locked !== undefined) this.locked = params.locked
+  }
+
   static override fromSexprPrimitives(
     primitiveSexprs: PrimitiveSExpr[],
   ): Segment {

package/lib/sexpr/classes/SegmentNet.ts

@@ -47,7 +47,9 @@ export class SegmentNet extends SxClass {
   }
 
   toObject(): { id: number; name?: string } {
-    return this._name === undefined ? { id: this._id } : { id: this._id, name: this._name }
+    return this._name === undefined
+      ? { id: this._id }
+      : { id: this._id, name: this._name }
   }
 
   override getChildren(): SxClass[] {

package/lib/sexpr/classes/Setup/PcbPlotParams.ts

@@ -208,11 +208,7 @@ export class PcbPlotParams extends SxClass {
   private setStringProperty<
     K extends PlotParamKey,
     T extends { new (value: string): PlotParamProperty<any> },
-  >(
-    key: K,
-    value: string | undefined,
-    ClassRef: T,
-  ) {
+  >(key: K, value: string | undefined, ClassRef: T) {
     if (value === undefined) {
       this.clearProperty(key)
       return
@@ -223,11 +219,7 @@ export class PcbPlotParams extends SxClass {
   private setNumberProperty<
     K extends PlotParamKey,
     T extends { new (value: number): PlotParamProperty<any> },
-  >(
-    key: K,
-    value: number | undefined,
-    ClassRef: T,
-  ) {
+  >(key: K, value: number | undefined, ClassRef: T) {
     if (value === undefined) {
       this.clearProperty(key)
       return
@@ -335,11 +327,7 @@ export class PcbPlotParams extends SxClass {
   }
 
   set excludeedgelayer(value: string | undefined) {
-    this.setStringProperty(
-      "excludeedgelayer",
-      value,
-      PlotParamExcludeEdgeLayer,
-    )
+    this.setStringProperty("excludeedgelayer", value, PlotParamExcludeEdgeLayer)
   }
 
   get dashed_line_dash_ratio(): number | undefined {
@@ -447,11 +435,7 @@ export class PcbPlotParams extends SxClass {
   }
 
   set sketchpadsonfab(value: string | undefined) {
-    this.setStringProperty(
-      "sketchpadsonfab",
-      value,
-      PlotParamSketchPadsOnFab,
-    )
+    this.setStringProperty("sketchpadsonfab", value, PlotParamSketchPadsOnFab)
   }
 
   get hidednponfab(): string | undefined {
@@ -475,11 +459,7 @@ export class PcbPlotParams extends SxClass {
   }
 
   set crossoutdnponfab(value: string | undefined) {
-    this.setStringProperty(
-      "crossoutdnponfab",
-      value,
-      PlotParamCrossoutDnpOnFab,
-    )
+    this.setStringProperty("crossoutdnponfab", value, PlotParamCrossoutDnpOnFab)
   }
 
   get subtractmaskfromsilk(): string | undefined {
@@ -571,11 +551,7 @@ export class PcbPlotParams extends SxClass {
   }
 
   set hpglpendiameter(value: number | undefined) {
-    this.setNumberProperty(
-      "hpglpendiameter",
-      value,
-      PlotParamHpglPenDiameter,
-    )
+    this.setNumberProperty("hpglpendiameter", value, PlotParamHpglPenDiameter)
   }
 
   get hpglpenoverlay(): number | undefined {
@@ -583,11 +559,7 @@ export class PcbPlotParams extends SxClass {
   }
 
   set hpglpenoverlay(value: number | undefined) {
-    this.setNumberProperty(
-      "hpglpenoverlay",
-      value,
-      PlotParamHpglPenOverlay,
-    )
+    this.setNumberProperty("hpglpenoverlay", value, PlotParamHpglPenOverlay)
   }
 
   get pdf_front_fp_property_popups(): string | undefined {
@@ -647,11 +619,7 @@ export class PcbPlotParams extends SxClass {
   }
 
   set dxfimperialunits(value: string | undefined) {
-    this.setStringProperty(
-      "dxfimperialunits",
-      value,
-      PlotParamDxfImperialUnits,
-    )
+    this.setStringProperty("dxfimperialunits", value, PlotParamDxfImperialUnits)
   }
 
   get dxfusepcbnewfont(): string | undefined {
@@ -659,11 +627,7 @@ export class PcbPlotParams extends SxClass {
   }
 
   set dxfusepcbnewfont(value: string | undefined) {
-    this.setStringProperty(
-      "dxfusepcbnewfont",
-      value,
-      PlotParamDxfUsePcbnewFont,
-    )
+    this.setStringProperty("dxfusepcbnewfont", value, PlotParamDxfUsePcbnewFont)
   }
 
   get psnegative(): string | undefined {
@@ -719,11 +683,7 @@ export class PcbPlotParams extends SxClass {
   }
 
   set outputdirectory(value: string | undefined) {
-    this.setStringProperty(
-      "outputdirectory",
-      value,
-      PlotParamOutputDirectory,
-    )
+    this.setStringProperty("outputdirectory", value, PlotParamOutputDirectory)
   }
 }
 SxClass.register(PcbPlotParams)

package/lib/sexpr/classes/Setup/Setup.ts

@@ -164,10 +164,7 @@ export class Setup extends SxClass {
     return children
   }
 
-  private setProperty(
-    key: SetupPropertyKey,
-    instance: SxClass | undefined,
-  ) {
+  private setProperty(key: SetupPropertyKey, instance: SxClass | undefined) {
     if (instance) {
       this._properties[key] = instance
       return
@@ -247,7 +244,11 @@ export class Setup extends SxClass {
   }
 
   set padToPasteClearance(value: number | undefined) {
-    this.setNumberProperty("padToPasteClearance", value, SetupPadToPasteClearance)
+    this.setNumberProperty(
+      "padToPasteClearance",
+      value,
+      SetupPadToPasteClearance,
+    )
   }
 
   get padToPasteClearanceRatio(): number | undefined {
@@ -266,10 +267,8 @@ export class Setup extends SxClass {
   }
 
   get lastTraceWidth(): number | undefined {
-    return this.getPropertyInstance(
-      "lastTraceWidth",
-      SetupLastTraceWidth,
-    )?.value
+    return this.getPropertyInstance("lastTraceWidth", SetupLastTraceWidth)
+      ?.value
   }
 
   set lastTraceWidth(value: number | undefined) {
@@ -277,7 +276,8 @@ export class Setup extends SxClass {
   }
 
   get traceClearance(): number | undefined {
-    return this.getPropertyInstance("traceClearance", SetupTraceClearance)?.value
+    return this.getPropertyInstance("traceClearance", SetupTraceClearance)
+      ?.value
   }
 
   set traceClearance(value: number | undefined) {
@@ -530,7 +530,8 @@ export class Setup extends SxClass {
   }
 
   get visibleElements(): string | undefined {
-    return this.getPropertyInstance("visibleElements", SetupVisibleElements)?.value
+    return this.getPropertyInstance("visibleElements", SetupVisibleElements)
+      ?.value
   }
 
   set visibleElements(value: string | undefined) {

package/lib/sexpr/classes/Setup/Stackup.ts

@@ -22,14 +22,16 @@ export class Stackup extends SxClass {
   private _sxCastellatedPads?: StackupCastellatedPads
   private _sxEdgePlating?: StackupEdgePlating
 
-  constructor(opts: {
-    layers?: StackupLayer[]
-    copperFinish?: StackupCopperFinish
-    dielectricConstraints?: StackupDielectricConstraints
-    edgeConnector?: StackupEdgeConnector
-    castellatedPads?: StackupCastellatedPads
-    edgePlating?: StackupEdgePlating
-  } = {}) {
+  constructor(
+    opts: {
+      layers?: StackupLayer[]
+      copperFinish?: StackupCopperFinish
+      dielectricConstraints?: StackupDielectricConstraints
+      edgeConnector?: StackupEdgeConnector
+      castellatedPads?: StackupCastellatedPads
+      edgePlating?: StackupEdgePlating
+    } = {},
+  ) {
     super()
     this.layers = opts.layers ?? []
     this._sxCopperFinish = opts.copperFinish
@@ -51,8 +53,7 @@ export class Stackup extends SxClass {
       dielectricConstraints:
         propertyMap.dielectric_constraints as StackupDielectricConstraints,
       edgeConnector: propertyMap.edge_connector as StackupEdgeConnector,
-      castellatedPads:
-        propertyMap.castellated_pads as StackupCastellatedPads,
+      castellatedPads: propertyMap.castellated_pads as StackupCastellatedPads,
       edgePlating: propertyMap.edge_plating as StackupEdgePlating,
     })
   }
@@ -75,9 +76,7 @@ export class Stackup extends SxClass {
   }
 
   set copperFinish(value: string | undefined) {
-    this._sxCopperFinish = value
-      ? new StackupCopperFinish(value)
-      : undefined
+    this._sxCopperFinish = value ? new StackupCopperFinish(value) : undefined
   }
 
   get dielectricConstraints(): string | undefined {
@@ -95,9 +94,7 @@ export class Stackup extends SxClass {
   }
 
   set edgeConnector(value: string | undefined) {
-    this._sxEdgeConnector = value
-      ? new StackupEdgeConnector(value)
-      : undefined
+    this._sxEdgeConnector = value ? new StackupEdgeConnector(value) : undefined
   }
 
   get castellatedPads(): string | undefined {
@@ -115,9 +112,7 @@ export class Stackup extends SxClass {
   }
 
   set edgePlating(value: string | undefined) {
-    this._sxEdgePlating = value
-      ? new StackupEdgePlating(value)
-      : undefined
+    this._sxEdgePlating = value ? new StackupEdgePlating(value) : undefined
   }
 
   override getChildren(): SxClass[] {

package/lib/sexpr/classes/Setup/StackupLayerProperties.ts

@@ -4,7 +4,9 @@ import { toNumberValue } from "../../utils/toNumberValue"
 
 import { SingleValueProperty } from "./base"
 
-abstract class StackupLayerProperty<T extends string | number> extends SingleValueProperty<T> {
+abstract class StackupLayerProperty<
+  T extends string | number,
+> extends SingleValueProperty<T> {
   static override parentToken = "layer"
 }
 

package/lib/sexpr/classes/Setup/StackupProperties.ts

@@ -38,4 +38,3 @@ export class StackupEdgePlating extends StackupSingleValueProperty<string> {
   token = "edge_plating"
 }
 SxClass.register(StackupEdgePlating)
-

package/lib/sexpr/classes/Setup/base.ts

@@ -56,9 +56,7 @@ export abstract class SingleValueProperty<
 
   protected formatValue(): string {
     if (typeof this._value === "string") {
-      return this.quoteStringValue
-        ? quoteSExprString(this._value)
-        : this._value
+      return this.quoteStringValue ? quoteSExprString(this._value) : this._value
     }
     return `${this._value}`
   }

package/lib/sexpr/classes/Setup/setupMultiValueProperties.ts

@@ -51,4 +51,3 @@ export class SetupGridOrigin extends SetupCoordinateProperty {
   token = "grid_origin"
 }
 SxClass.register(SetupGridOrigin)
-

package/lib/sexpr/classes/Sheet.ts

@@ -4,7 +4,7 @@ import { indentLines } from "../utils/indentLines"
 import { quoteSExprString } from "../utils/quoteSExprString"
 import { toNumberValue } from "../utils/toNumberValue"
 import { toStringValue } from "../utils/toStringValue"
-import { At } from "./At"
+import { At, type AtInput } from "./At"
 import { Color } from "./Color"
 import { Dnp } from "./Dnp"
 import { ExcludeFromSim } from "./ExcludeFromSim"
@@ -21,6 +21,22 @@ import { SheetFill } from "./SheetFill"
 import { SheetSize } from "./SheetSize"
 import { SheetProperty } from "./SheetProperty"
 
+export interface SheetConstructorParams {
+  position?: AtInput
+  size?: SheetSize | { width: number; height: number }
+  excludeFromSim?: boolean | ExcludeFromSim
+  inBom?: boolean | InBom
+  onBoard?: boolean | OnBoard
+  dnp?: boolean | Dnp
+  fieldsAutoplaced?: boolean | FieldsAutoplaced
+  stroke?: Stroke
+  fill?: SheetFill
+  uuid?: string | Uuid
+  properties?: SheetProperty[]
+  pins?: SheetPin[]
+  instances?: SheetInstances
+}
+
 export class Sheet extends SxClass {
   static override token = "sheet"
   token = "sheet"
@@ -39,6 +55,72 @@ export class Sheet extends SxClass {
   private _pins: SheetPin[] = []
   private _sxInstances?: SheetInstances
 
+  constructor(params: SheetConstructorParams = {}) {
+    super()
+
+    if (params.position !== undefined) {
+      this.position = params.position
+    }
+
+    if (params.size !== undefined) {
+      this.size = params.size
+    }
+
+    if (params.excludeFromSim !== undefined) {
+      this.excludeFromSim =
+        typeof params.excludeFromSim === "boolean"
+          ? params.excludeFromSim
+          : params.excludeFromSim.value
+    }
+
+    if (params.inBom !== undefined) {
+      this.inBom =
+        typeof params.inBom === "boolean" ? params.inBom : params.inBom.value
+    }
+
+    if (params.onBoard !== undefined) {
+      this.onBoard =
+        typeof params.onBoard === "boolean"
+          ? params.onBoard
+          : params.onBoard.value
+    }
+
+    if (params.dnp !== undefined) {
+      this.dnp = typeof params.dnp === "boolean" ? params.dnp : params.dnp.value
+    }
+
+    if (params.fieldsAutoplaced !== undefined) {
+      this.fieldsAutoplaced =
+        typeof params.fieldsAutoplaced === "boolean"
+          ? params.fieldsAutoplaced
+          : params.fieldsAutoplaced.value
+    }
+
+    if (params.stroke !== undefined) {
+      this.stroke = params.stroke
+    }
+
+    if (params.fill !== undefined) {
+      this.fill = params.fill
+    }
+
+    if (params.uuid !== undefined) {
+      this.uuid = params.uuid
+    }
+
+    if (params.properties !== undefined) {
+      this.properties = params.properties
+    }
+
+    if (params.pins !== undefined) {
+      this.pins = params.pins
+    }
+
+    if (params.instances !== undefined) {
+      this.instances = params.instances
+    }
+  }
+
   static override fromSexprPrimitives(
     primitiveSexprs: PrimitiveSExpr[],
   ): Sheet {
@@ -72,8 +154,8 @@ export class Sheet extends SxClass {
     return this._sxAt
   }
 
-  set position(value: At | undefined) {
-    this._sxAt = value
+  set position(value: AtInput | undefined) {
+    this._sxAt = value !== undefined ? At.from(value) : undefined
   }
 
   get size(): { width: number; height: number } | undefined {

package/lib/sexpr/classes/SheetPin.ts

@@ -48,7 +48,10 @@ export class SheetPin extends SxClass {
     }
 
     const electricalType = toStringValue(rawType)
-    if (!electricalType || !electricalTypes.has(electricalType as SheetPinElectricalType)) {
+    if (
+      !electricalType ||
+      !electricalTypes.has(electricalType as SheetPinElectricalType)
+    ) {
       throw new Error(
         `sheet pin electrical type must be one of: ${Array.from(electricalTypes).join(", ")}`,
       )