kicadts 0.0.1 → 0.0.2

package/lib/sexpr/classes/FpText.ts

@@ -2,7 +2,7 @@ import { SxClass } from "../base-classes/SxClass"
 import { printSExpr, 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 { Layer } from "./Layer"
 import { TextEffects } from "./TextEffects"
 import { Uuid } from "./Uuid"
@@ -22,6 +22,17 @@ const SUPPORTED_SINGLE_TOKENS = new Set([
 
 const SUPPORTED_MULTI_TOKENS = new Set<string>()
 
+export interface FpTextConstructorParams {
+  type?: FpTextType
+  text?: string
+  position?: AtInput | Xy
+  unlocked?: boolean
+  hidden?: boolean
+  layer?: Layer | string | string[]
+  effects?: TextEffects
+  uuid?: Uuid | string
+}
+
 export class FpText extends SxClass {
   static override token = "fp_text"
   token = "fp_text"
@@ -35,6 +46,18 @@ export class FpText extends SxClass {
   private _sxEffects?: TextEffects
   private _sxUuid?: Uuid
 
+  constructor(params: FpTextConstructorParams = {}) {
+    super()
+    if (params.type !== undefined) this.type = params.type
+    if (params.text !== undefined) this.text = params.text
+    if (params.position !== undefined) this.position = params.position
+    if (params.unlocked !== undefined) this.unlocked = params.unlocked
+    if (params.hidden !== undefined) this.hidden = params.hidden
+    if (params.layer !== undefined) this.layer = params.layer
+    if (params.effects !== undefined) this.effects = params.effects
+    if (params.uuid !== undefined) this.uuid = params.uuid
+  }
+
   static override fromSexprPrimitives(
     primitiveSexprs: PrimitiveSExpr[],
   ): FpText {
@@ -62,7 +85,9 @@ export class FpText extends SxClass {
       if (typeof primitive === "string") {
         if (primitive === "unlocked") {
           if (sawBareUnlocked) {
-            throw new Error("fp_text encountered duplicate bare unlocked tokens")
+            throw new Error(
+              "fp_text encountered duplicate bare unlocked tokens",
+            )
           }
           sawBareUnlocked = true
           continue
@@ -74,9 +99,7 @@ export class FpText extends SxClass {
           sawBareHide = true
           continue
         }
-        throw new Error(
-          `fp_text encountered unsupported flag "${primitive}"`,
-        )
+        throw new Error(`fp_text encountered unsupported flag "${primitive}"`)
       }
 
       if (!Array.isArray(primitive) || primitive.length === 0) {
@@ -170,8 +193,17 @@ export class FpText extends SxClass {
     return this._sxPosition
   }
 
-  set position(value: At | Xy | undefined) {
-    this._sxPosition = value
+  set position(value: AtInput | Xy | undefined) {
+    if (value === undefined) {
+      this._sxPosition = undefined
+      return
+    }
+    if (value instanceof Xy) {
+      this._sxPosition = value
+      return
+    }
+    // Handle AtInput (At, array, or object)
+    this._sxPosition = At.from(value as AtInput)
   }
 
   get unlocked(): boolean {
@@ -287,7 +319,8 @@ class FpTextUnlocked extends SxClass {
   ): FpTextUnlocked {
     const [raw] = primitiveSexprs
     const rawString = toStringValue(raw)
-    const value = rawString === undefined ? true : !/^(no|false)$/iu.test(rawString)
+    const value =
+      rawString === undefined ? true : !/^(no|false)$/iu.test(rawString)
     return new FpTextUnlocked({ value, bare: false })
   }
 
@@ -323,7 +356,8 @@ class FpTextHide extends SxClass {
   ): FpTextHide {
     const [raw] = primitiveSexprs
     const rawString = toStringValue(raw)
-    const value = rawString === undefined ? true : !/^(no|false)$/iu.test(rawString)
+    const value =
+      rawString === undefined ? true : !/^(no|false)$/iu.test(rawString)
     return new FpTextHide({ value, bare: false })
   }
 

package/lib/sexpr/classes/FpTextBox.ts

@@ -31,6 +31,20 @@ const SUPPORTED_SINGLE_TOKENS = new Set([
 
 const SUPPORTED_MULTI_TOKENS = new Set<string>()
 
+export interface FpTextBoxConstructorParams {
+  locked?: boolean
+  text?: string
+  start?: FpTextBoxStart | { x: number; y: number }
+  end?: FpTextBoxEnd | { x: number; y: number }
+  pts?: Pts
+  angle?: FpTextBoxAngle | number
+  layer?: Layer | string | string[]
+  uuid?: Uuid | string
+  effects?: TextEffects
+  stroke?: Stroke
+  renderCache?: RenderCache
+}
+
 export class FpTextBox extends SxClass {
   static override token = "fp_text_box"
   token = "fp_text_box"
@@ -47,6 +61,21 @@ export class FpTextBox extends SxClass {
   private _sxStroke?: Stroke
   private _sxRenderCache?: RenderCache
 
+  constructor(params: FpTextBoxConstructorParams = {}) {
+    super()
+    if (params.locked !== undefined) this.locked = params.locked
+    if (params.text !== undefined) this.text = params.text
+    if (params.start !== undefined) this.start = params.start
+    if (params.end !== undefined) this.end = params.end
+    if (params.pts !== undefined) this.pts = params.pts
+    if (params.angle !== undefined) this.angle = params.angle
+    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.stroke !== undefined) this.stroke = params.stroke
+    if (params.renderCache !== undefined) this.renderCache = params.renderCache
+  }
+
   static override fromSexprPrimitives(
     primitiveSexprs: PrimitiveSExpr[],
   ): FpTextBox {
@@ -134,7 +163,9 @@ export class FpTextBox extends SxClass {
     fpTextBox._sxUuid = propertyMap.uuid as Uuid | undefined
     fpTextBox._sxEffects = propertyMap.effects as TextEffects | undefined
     fpTextBox._sxStroke = propertyMap.stroke as Stroke | undefined
-    fpTextBox._sxRenderCache = propertyMap.render_cache as RenderCache | undefined
+    fpTextBox._sxRenderCache = propertyMap.render_cache as
+      | RenderCache
+      | undefined
 
     return fpTextBox
   }
@@ -164,7 +195,10 @@ export class FpTextBox extends SxClass {
       this._sxStart = undefined
       return
     }
-    this._sxStart = value instanceof FpTextBoxStart ? value : new FpTextBoxStart([value.x, value.y])
+    this._sxStart =
+      value instanceof FpTextBoxStart
+        ? value
+        : new FpTextBoxStart([value.x, value.y])
   }
 
   get end(): FpTextBoxEnd | undefined {
@@ -176,7 +210,10 @@ export class FpTextBox extends SxClass {
       this._sxEnd = undefined
       return
     }
-    this._sxEnd = value instanceof FpTextBoxEnd ? value : new FpTextBoxEnd([value.x, value.y])
+    this._sxEnd =
+      value instanceof FpTextBoxEnd
+        ? value
+        : new FpTextBoxEnd([value.x, value.y])
   }
 
   get pts(): Pts | undefined {
@@ -196,7 +233,8 @@ export class FpTextBox extends SxClass {
       this._sxAngle = undefined
       return
     }
-    this._sxAngle = value instanceof FpTextBoxAngle ? value : new FpTextBoxAngle([value])
+    this._sxAngle =
+      value instanceof FpTextBoxAngle ? value : new FpTextBoxAngle([value])
   }
 
   get layer(): Layer | undefined {
@@ -378,7 +416,7 @@ export class FpTextBoxAngle extends SxClass {
     const numeric =
       typeof raw === "number"
         ? raw
-        : toNumberValue(raw as PrimitiveSExpr) ?? 0
+        : (toNumberValue(raw as PrimitiveSExpr) ?? 0)
     return new FpTextBoxAngle([numeric])
   }
 

package/lib/sexpr/classes/GrLine.ts

@@ -25,6 +25,17 @@ const SUPPORTED_SINGLE_TOKENS = new Set([
   "locked",
 ])
 
+export interface GrLineConstructorParams {
+  start?: GrLineStart | GrLinePoint
+  end?: GrLineEnd | GrLinePoint
+  angle?: number
+  layer?: Layer | string | Array<string | number>
+  width?: Width | number
+  stroke?: Stroke
+  uuid?: Uuid | string
+  locked?: boolean
+}
+
 export class GrLine extends SxClass {
   static override token = "gr_line"
   override token = "gr_line"
@@ -38,8 +49,16 @@ export class GrLine extends SxClass {
   private _sxUuid?: Uuid
   private _sxLocked?: GrLineLocked
 
-  constructor() {
+  constructor(params: GrLineConstructorParams = {}) {
     super()
+    if (params.start !== undefined) this.start = params.start
+    if (params.end !== undefined) this.end = params.end
+    if (params.angle !== undefined) this.angle = params.angle
+    if (params.layer !== undefined) this.layer = params.layer
+    if (params.width !== undefined) this.width = params.width
+    if (params.stroke !== undefined) this.stroke = params.stroke
+    if (params.uuid !== undefined) this.uuid = params.uuid
+    if (params.locked !== undefined) this.locked = params.locked
   }
 
   static override fromSexprPrimitives(

package/lib/sexpr/classes/GrText.ts

@@ -2,7 +2,7 @@ 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 { Xy } from "./Xy"
 import { Layer } from "./Layer"
 import { TextEffects } from "./TextEffects"
@@ -22,6 +22,14 @@ const SUPPORTED_SINGLE_TOKENS = new Set([
   "effects",
 ])
 
+export interface GrTextConstructorParams {
+  text?: string
+  position?: AtInput | Xy | GrTextPosition
+  layer?: Layer | string | Array<string | number>
+  uuid?: Uuid | string
+  effects?: TextEffects
+}
+
 export class GrText extends SxClass {
   static override token = "gr_text"
   override token = "gr_text"
@@ -32,9 +40,17 @@ export class GrText extends SxClass {
   private _sxUuid?: Uuid
   private _sxEffects?: TextEffects
 
-  constructor(text = "") {
+  constructor(params: GrTextConstructorParams | string = {}) {
     super()
-    this.text = text
+    if (typeof params === "string") {
+      this.text = params
+    } else {
+      if (params.text !== undefined) this.text = params.text
+      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
+    }
   }
 
   static override fromSexprPrimitives(
@@ -125,23 +141,33 @@ export class GrText extends SxClass {
     return this._sxPosition
   }
 
-  set position(
-    value: At | Xy | GrTextPosition | undefined,
-  ) {
+  set position(value: AtInput | Xy | GrTextPosition | undefined,) {
     if (value === undefined) {
       this._sxPosition = undefined
       return
     }
-    if (value instanceof At || value instanceof Xy) {
+    if (value instanceof Xy) {
       this._sxPosition = value
       return
     }
-    const { x, y, angle } = value
-    if (angle !== undefined) {
-      this._sxPosition = new At([x, y, angle])
-    } else {
-      this._sxPosition = new Xy(x, y)
+    // Check if it's GrTextPosition (plain object with x, y)
+    if (
+      typeof value === "object" &&
+      "x" in value &&
+      "y" in value &&
+      !Array.isArray(value) &&
+      !(value instanceof At)
+    ) {
+      const { x, y, angle } = value as GrTextPosition
+      if (angle !== undefined) {
+        this._sxPosition = new At([x, y, angle])
+      } else {
+        this._sxPosition = new Xy(x, y)
+      }
+      return
     }
+    // Handle AtInput (At, array, or object with angle)
+    this._sxPosition = At.from(value as AtInput)
   }
 
   get layer(): Layer | undefined {

package/lib/sexpr/classes/Image.ts

@@ -5,7 +5,7 @@ import { toNumberValue } from "../utils/toNumberValue"
 import { toStringValue } from "../utils/toStringValue"
 import { Layer } from "./Layer"
 import { Uuid } from "./Uuid"
-import { At } from "./At"
+import { At, type AtInput } from "./At"
 import { Xy } from "./Xy"
 
 const SUPPORTED_SINGLE_TOKENS = new Set([
@@ -19,6 +19,14 @@ const SUPPORTED_SINGLE_TOKENS = new Set([
 
 const SUPPORTED_MULTI_TOKENS = new Set<string>()
 
+export interface ImageConstructorParams {
+  position?: AtInput | Xy
+  scale?: ImageScale | number
+  layer?: Layer | string | string[]
+  uuid?: Uuid | string
+  data?: ImageData | string | string[]
+}
+
 export class Image extends SxClass {
   static override token = "image"
   token = "image"
@@ -29,6 +37,16 @@ export class Image extends SxClass {
   private _sxUuid?: Uuid
   private _sxData?: ImageData
 
+  constructor(params: ImageConstructorParams = {}) {
+    super()
+
+    if (params.position !== undefined) this.position = params.position
+    if (params.scale !== undefined) this.scale = params.scale
+    if (params.layer !== undefined) this.layer = params.layer
+    if (params.uuid !== undefined) this.uuid = params.uuid
+    if (params.data !== undefined) this.data = params.data
+  }
+
   static override fromSexprPrimitives(
     primitiveSexprs: PrimitiveSExpr[],
   ): Image {
@@ -51,17 +69,13 @@ export class Image extends SxClass {
 
     for (const token of Object.keys(propertyMap)) {
       if (!SUPPORTED_SINGLE_TOKENS.has(token)) {
-        throw new Error(
-          `image encountered unsupported child token "${token}"`,
-        )
+        throw new Error(`image encountered unsupported child token "${token}"`)
       }
     }
 
     for (const [token, entries] of Object.entries(arrayPropertyMap)) {
       if (!SUPPORTED_SINGLE_TOKENS.has(token)) {
-        throw new Error(
-          `image encountered unsupported child token "${token}"`,
-        )
+        throw new Error(`image encountered unsupported child token "${token}"`)
       }
       if (!SUPPORTED_MULTI_TOKENS.has(token) && entries.length > 1) {
         throw new Error(
@@ -89,8 +103,17 @@ export class Image extends SxClass {
     return this._sxPosition
   }
 
-  set position(value: At | Xy | undefined) {
-    this._sxPosition = value
+  set position(value: AtInput | Xy | undefined) {
+    if (value === undefined) {
+      this._sxPosition = undefined
+      return
+    }
+    if (value instanceof Xy) {
+      this._sxPosition = value
+      return
+    }
+    // Handle AtInput (At, array, or object)
+    this._sxPosition = At.from(value as AtInput)
   }
 
   get scale(): ImageScale | undefined {
@@ -209,7 +232,9 @@ export class ImageData extends SxClass {
   static override fromSexprPrimitives(
     primitiveSexprs: PrimitiveSExpr[],
   ): ImageData {
-    const chunks = primitiveSexprs.map((primitive) => primitiveToChunk(primitive))
+    const chunks = primitiveSexprs.map((primitive) =>
+      primitiveToChunk(primitive),
+    )
     return new ImageData(chunks)
   }
 
@@ -241,7 +266,9 @@ export class ImageData extends SxClass {
     if (this._chunks.length === 0) {
       return "(data)"
     }
-    const rendered = this._chunks.map((chunk) => quoteSExprString(chunk)).join(" ")
+    const rendered = this._chunks
+      .map((chunk) => quoteSExprString(chunk))
+      .join(" ")
     return `(data ${rendered})`
   }
 }

package/lib/sexpr/classes/Junction.ts

@@ -1,12 +1,19 @@
 import { SxClass } from "../base-classes/SxClass"
 import type { PrimitiveSExpr } from "../parseToPrimitiveSExpr"
-import { At } from "./At"
+import { At, type AtInput } from "./At"
 import { Color } from "./Color"
 import { Uuid } from "./Uuid"
 import { SxPrimitiveNumber } from "../base-classes/SxPrimitiveNumber"
 
 const SUPPORTED_TOKENS = new Set(["at", "diameter", "color", "uuid"])
 
+export interface JunctionConstructorParams {
+  at?: AtInput
+  diameter?: number | JunctionDiameter
+  color?: Color
+  uuid?: string | Uuid
+}
+
 export class Junction extends SxClass {
   static override token = "junction"
   static override parentToken = "kicad_sch"
@@ -17,6 +24,30 @@ export class Junction extends SxClass {
   private _sxColor?: Color
   private _sxUuid?: Uuid
 
+  constructor(params: JunctionConstructorParams = {}) {
+    super()
+
+    if (params.at !== undefined) {
+      this.at = params.at
+    }
+
+    if (params.diameter !== undefined) {
+      if (params.diameter instanceof JunctionDiameter) {
+        this._sxDiameter = params.diameter
+      } else {
+        this.diameter = params.diameter
+      }
+    }
+
+    if (params.color !== undefined) {
+      this.color = params.color
+    }
+
+    if (params.uuid !== undefined) {
+      this.uuid = params.uuid
+    }
+  }
+
   static override fromSexprPrimitives(
     primitiveSexprs: PrimitiveSExpr[],
   ): Junction {
@@ -83,8 +114,8 @@ export class Junction 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 diameter(): number | undefined {
@@ -92,7 +123,8 @@ export class Junction extends SxClass {
   }
 
   set diameter(value: number | undefined) {
-    this._sxDiameter = value === undefined ? undefined : new JunctionDiameter(value)
+    this._sxDiameter =
+      value === undefined ? undefined : new JunctionDiameter(value)
   }
 
   get color(): Color | undefined {

package/lib/sexpr/classes/KicadPcb.ts

@@ -18,6 +18,27 @@ import { TitleBlock } from "./TitleBlock"
 import { Via } from "./Via"
 import { Zone } from "./Zone"
 
+export interface KicadPcbConstructorParams {
+  version?: number
+  generator?: string
+  generatorVersion?: string
+  general?: PcbGeneral
+  paper?: Paper
+  titleBlock?: TitleBlock
+  layers?: PcbLayers
+  setup?: Setup
+  properties?: Property[]
+  nets?: PcbNet[]
+  footprints?: Footprint[]
+  images?: Image[]
+  segments?: Segment[]
+  graphicLines?: GrLine[]
+  graphicTexts?: GrText[]
+  vias?: Via[]
+  zones?: Zone[]
+  otherChildren?: SxClass[]
+}
+
 export class KicadPcb extends SxClass {
   static override token = "kicad_pcb"
   token = "kicad_pcb"
@@ -41,6 +62,32 @@ export class KicadPcb extends SxClass {
   private _zones: Zone[] = []
   private _otherChildren: SxClass[] = []
 
+  constructor(params: KicadPcbConstructorParams = {}) {
+    super()
+    if (params.version !== undefined) this.version = params.version
+    if (params.generator !== undefined) this.generator = params.generator
+    if (params.generatorVersion !== undefined)
+      this.generatorVersion = params.generatorVersion
+    if (params.general !== undefined) this.general = params.general
+    if (params.paper !== undefined) this.paper = params.paper
+    if (params.titleBlock !== undefined) this.titleBlock = params.titleBlock
+    if (params.layers !== undefined) this.layers = params.layers
+    if (params.setup !== undefined) this.setup = params.setup
+    if (params.properties !== undefined) this.properties = params.properties
+    if (params.nets !== undefined) this.nets = params.nets
+    if (params.footprints !== undefined) this.footprints = params.footprints
+    if (params.images !== undefined) this.images = params.images
+    if (params.segments !== undefined) this.segments = params.segments
+    if (params.graphicLines !== undefined)
+      this.graphicLines = params.graphicLines
+    if (params.graphicTexts !== undefined)
+      this.graphicTexts = params.graphicTexts
+    if (params.vias !== undefined) this.vias = params.vias
+    if (params.zones !== undefined) this.zones = params.zones
+    if (params.otherChildren !== undefined)
+      this.otherChildren = params.otherChildren
+  }
+
   static override fromSexprPrimitives(
     primitiveSexprs: PrimitiveSExpr[],
   ): KicadPcb {
@@ -155,7 +202,8 @@ export class KicadPcb extends SxClass {
   }
 
   set generator(value: string | undefined) {
-    this._sxGenerator = value === undefined ? undefined : new PcbGenerator(value)
+    this._sxGenerator =
+      value === undefined ? undefined : new PcbGenerator(value)
   }
 
   get generatorVersion(): string | undefined {