kicadts 0.0.1 → 0.0.2

package/lib/sexpr/classes/KicadSch.ts

@@ -46,6 +46,26 @@ const SUPPORTED_CHILD_TOKENS = new Set([
   ...MULTI_CHILD_TOKENS,
 ])
 
+export interface KicadSchConstructorParams {
+  version?: number | KicadSchVersion
+  generator?: string | KicadSchGenerator
+  generatorVersion?: string | KicadSchGeneratorVersion
+  uuid?: string | Uuid
+  paper?: Paper
+  titleBlock?: TitleBlock
+  libSymbols?: LibSymbols
+  sheetInstances?: SheetInstances
+  embeddedFonts?: EmbeddedFonts
+  properties?: Property[]
+  images?: Image[]
+  sheets?: Sheet[]
+  symbols?: SchematicSymbol[]
+  texts?: SchematicText[]
+  labels?: Label[]
+  wires?: Wire[]
+  junctions?: Junction[]
+}
+
 export class KicadSch extends SxClass {
   static override token = "kicad_sch"
   token = "kicad_sch"
@@ -68,11 +88,87 @@ export class KicadSch extends SxClass {
   private _wires: Wire[] = []
   private _junctions: Junction[] = []
 
+  constructor(params: KicadSchConstructorParams = {}) {
+    super()
+
+    if (params.version instanceof KicadSchVersion) {
+      this._sxVersion = params.version
+    } else if (params.version !== undefined) {
+      this.version = params.version
+    }
+
+    if (params.generator instanceof KicadSchGenerator) {
+      this._sxGenerator = params.generator
+    } else if (params.generator !== undefined) {
+      this.generator = params.generator
+    }
+
+    if (params.generatorVersion instanceof KicadSchGeneratorVersion) {
+      this._sxGeneratorVersion = params.generatorVersion
+    } else if (params.generatorVersion !== undefined) {
+      this.generatorVersion = params.generatorVersion
+    }
+
+    if (params.uuid !== undefined) {
+      this.uuid = params.uuid
+    }
+
+    if (params.paper !== undefined) {
+      this.paper = params.paper
+    }
+
+    if (params.titleBlock !== undefined) {
+      this.titleBlock = params.titleBlock
+    }
+
+    if (params.libSymbols !== undefined) {
+      this.libSymbols = params.libSymbols
+    }
+
+    if (params.sheetInstances !== undefined) {
+      this.sheetInstances = params.sheetInstances
+    }
+
+    if (params.embeddedFonts !== undefined) {
+      this.embeddedFonts = params.embeddedFonts
+    }
+
+    if (params.properties !== undefined) {
+      this.properties = params.properties
+    }
+
+    if (params.images !== undefined) {
+      this.images = params.images
+    }
+
+    if (params.sheets !== undefined) {
+      this.sheets = params.sheets
+    }
+
+    if (params.symbols !== undefined) {
+      this.symbols = params.symbols
+    }
+
+    if (params.texts !== undefined) {
+      this.texts = params.texts
+    }
+
+    if (params.labels !== undefined) {
+      this.labels = params.labels
+    }
+
+    if (params.wires !== undefined) {
+      this.wires = params.wires
+    }
+
+    if (params.junctions !== undefined) {
+      this.junctions = params.junctions
+    }
+  }
+
   static override fromSexprPrimitives(
     primitiveSexprs: PrimitiveSExpr[],
   ): KicadSch {
-    const kicadSch = new KicadSch()
-
     for (const primitive of primitiveSexprs) {
       if (!Array.isArray(primitive)) {
         throw new Error(
@@ -110,29 +206,27 @@ export class KicadSch extends SxClass {
       }
     }
 
-    kicadSch._sxVersion = propertyMap.version as KicadSchVersion | undefined
-    kicadSch._sxGenerator = propertyMap.generator as
-      | KicadSchGenerator
-      | undefined
-    kicadSch._sxGeneratorVersion = propertyMap.generator_version as
-      | KicadSchGeneratorVersion
-      | undefined
-    kicadSch._sxUuid = propertyMap.uuid as Uuid | undefined
-    kicadSch._sxPaper = propertyMap.paper as Paper | undefined
-    kicadSch._sxTitleBlock = propertyMap.title_block as TitleBlock | undefined
-    kicadSch._sxLibSymbols = propertyMap.lib_symbols as LibSymbols | undefined
-    kicadSch._sxSheetInstances = propertyMap.sheet_instances as SheetInstances | undefined
-    kicadSch._sxEmbeddedFonts = propertyMap.embedded_fonts as EmbeddedFonts | undefined
-    kicadSch._properties = (arrayPropertyMap.property as Property[]) ?? []
-    kicadSch._images = (arrayPropertyMap.image as Image[]) ?? []
-    kicadSch._sheets = (arrayPropertyMap.sheet as Sheet[]) ?? []
-    kicadSch._symbols = (arrayPropertyMap.symbol as SchematicSymbol[]) ?? []
-    kicadSch._texts = (arrayPropertyMap.text as SchematicText[]) ?? []
-    kicadSch._labels = (arrayPropertyMap.label as Label[]) ?? []
-    kicadSch._junctions = (arrayPropertyMap.junction as Junction[]) ?? []
-    kicadSch._wires = (arrayPropertyMap.wire as Wire[]) ?? []
-
-    return kicadSch
+    return new KicadSch({
+      version: propertyMap.version as KicadSchVersion | undefined,
+      generator: propertyMap.generator as KicadSchGenerator | undefined,
+      generatorVersion: propertyMap.generator_version as
+        | KicadSchGeneratorVersion
+        | undefined,
+      uuid: propertyMap.uuid as Uuid | undefined,
+      paper: propertyMap.paper as Paper | undefined,
+      titleBlock: propertyMap.title_block as TitleBlock | undefined,
+      libSymbols: propertyMap.lib_symbols as LibSymbols | undefined,
+      sheetInstances: propertyMap.sheet_instances as SheetInstances | undefined,
+      embeddedFonts: propertyMap.embedded_fonts as EmbeddedFonts | undefined,
+      properties: (arrayPropertyMap.property as Property[]) ?? [],
+      images: (arrayPropertyMap.image as Image[]) ?? [],
+      sheets: (arrayPropertyMap.sheet as Sheet[]) ?? [],
+      symbols: (arrayPropertyMap.symbol as SchematicSymbol[]) ?? [],
+      texts: (arrayPropertyMap.text as SchematicText[]) ?? [],
+      labels: (arrayPropertyMap.label as Label[]) ?? [],
+      junctions: (arrayPropertyMap.junction as Junction[]) ?? [],
+      wires: (arrayPropertyMap.wire as Wire[]) ?? [],
+    })
   }
 
   get version(): number | undefined {

package/lib/sexpr/classes/Label.ts

@@ -2,13 +2,21 @@ 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 { TextEffects } from "./TextEffects"
 import { Uuid } from "./Uuid"
 import { FieldsAutoplaced } from "./FieldsAutoplaced"
 
 const SUPPORTED_TOKENS = new Set(["at", "effects", "uuid", "fields_autoplaced"])
 
+export interface LabelConstructorParams {
+  value?: string
+  at?: AtInput
+  effects?: TextEffects
+  uuid?: string | Uuid
+  fieldsAutoplaced?: boolean | FieldsAutoplaced
+}
+
 export class Label extends SxClass {
   static override token = "label"
   static override parentToken = "kicad_sch"
@@ -20,6 +28,34 @@ export class Label extends SxClass {
   private _sxUuid?: Uuid
   private _sxFieldsAutoplaced?: FieldsAutoplaced
 
+  constructor(params: LabelConstructorParams = {}) {
+    super()
+
+    if (params.value !== undefined) {
+      this.value = params.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
+    }
+
+    if (params.fieldsAutoplaced !== undefined) {
+      if (params.fieldsAutoplaced instanceof FieldsAutoplaced) {
+        this._sxFieldsAutoplaced = params.fieldsAutoplaced
+      } else {
+        this.fieldsAutoplaced = params.fieldsAutoplaced
+      }
+    }
+  }
+
   static override fromSexprPrimitives(
     primitiveSexprs: PrimitiveSExpr[],
   ): Label {
@@ -51,7 +87,9 @@ export class Label extends SxClass {
         )
       }
       if (entries.length > 1) {
-        throw new Error(`label does not support repeated child tokens: ${token}`)
+        throw new Error(
+          `label does not support repeated child tokens: ${token}`,
+        )
       }
     }
 
@@ -65,7 +103,9 @@ export class Label extends SxClass {
       (arrayPropertyMap.uuid?.[0] as Uuid | undefined) ??
       (propertyMap.uuid as Uuid | undefined)
     label._sxFieldsAutoplaced =
-      (arrayPropertyMap.fields_autoplaced?.[0] as FieldsAutoplaced | undefined) ??
+      (arrayPropertyMap.fields_autoplaced?.[0] as
+        | FieldsAutoplaced
+        | undefined) ??
       (propertyMap.fields_autoplaced as FieldsAutoplaced | undefined)
 
     return label
@@ -83,8 +123,8 @@ export class Label 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/NoConnect.ts

@@ -1,10 +1,15 @@
 import { SxClass } from "../base-classes/SxClass"
 import type { PrimitiveSExpr } from "../parseToPrimitiveSExpr"
-import { At } from "./At"
+import { At, type AtInput } from "./At"
 import { Uuid } from "./Uuid"
 
 const SUPPORTED_TOKENS = new Set(["at", "uuid"])
 
+export interface NoConnectConstructorParams {
+  at?: AtInput
+  uuid?: string | Uuid
+}
+
 export class NoConnect extends SxClass {
   static override token = "no_connect"
   static override parentToken = "kicad_sch"
@@ -13,6 +18,18 @@ export class NoConnect extends SxClass {
   private _sxAt?: At
   private _sxUuid?: Uuid
 
+  constructor(params: NoConnectConstructorParams = {}) {
+    super()
+
+    if (params.at !== undefined) {
+      this.at = params.at
+    }
+
+    if (params.uuid !== undefined) {
+      this.uuid = params.uuid
+    }
+  }
+
   static override fromSexprPrimitives(
     primitiveSexprs: PrimitiveSExpr[],
   ): NoConnect {
@@ -47,8 +64,8 @@ export class NoConnect 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 uuid(): Uuid | undefined {

package/lib/sexpr/classes/PadLayers.ts

@@ -4,6 +4,8 @@ import { printSExpr } from "../parseToPrimitiveSExpr"
 import { quoteSExprString } from "../utils/quoteSExprString"
 import { toStringValue } from "../utils/toStringValue"
 
+export type PadLayersInput = PadLayers | string[]
+
 export class PadLayers extends SxClass {
   static override token = "layers"
   static override parentToken = "pad"
@@ -16,6 +18,13 @@ export class PadLayers extends SxClass {
     this.layers = layers
   }
 
+  static from(input: PadLayersInput): PadLayers {
+    if (input instanceof PadLayers) {
+      return input
+    }
+    return new PadLayers(input)
+  }
+
   static override fromSexprPrimitives(
     primitiveSexprs: PrimitiveSExpr[],
   ): PadLayers {
@@ -47,7 +56,10 @@ export class PadLayers extends SxClass {
     }
     const rendered = this._layers
       .map((layer) => {
-        if (/^[^\s()"]+$/u.test(layer) && !["nil", "#t", "#f"].includes(layer)) {
+        if (
+          /^[^\s()"]+$/u.test(layer) &&
+          !["nil", "#t", "#f"].includes(layer)
+        ) {
           return layer
         }
         return quoteSExprString(layer)

package/lib/sexpr/classes/PadOptions.ts

@@ -5,10 +5,7 @@ import { toStringValue } from "../utils/toStringValue"
 export type PadOptionsClearanceType = "outline" | "convexhull"
 export type PadOptionsAnchorShape = "rect" | "circle"
 
-const CLEARANCE_TYPES: PadOptionsClearanceType[] = [
-  "outline",
-  "convexhull",
-]
+const CLEARANCE_TYPES: PadOptionsClearanceType[] = ["outline", "convexhull"]
 
 const ANCHOR_SHAPES: PadOptionsAnchorShape[] = ["rect", "circle"]
 
@@ -58,7 +55,9 @@ export class PadOptions extends SxClass {
         continue
       }
 
-      throw new Error(`pad options encountered unsupported token "${parsed.token}"`)
+      throw new Error(
+        `pad options encountered unsupported token "${parsed.token}"`,
+      )
     }
 
     return options

package/lib/sexpr/classes/PadPrimitiveGrArc.ts

@@ -5,6 +5,13 @@ import { toNumberValue } from "../utils/toNumberValue"
 
 const SUPPORTED_TOKENS = new Set(["start", "mid", "end", "width"])
 
+export interface PadPrimitiveGrArcConstructorParams {
+  start?: PadPrimitiveGrArcStart | { x: number; y: number }
+  mid?: PadPrimitiveGrArcMid | { x: number; y: number }
+  end?: PadPrimitiveGrArcEnd | { x: number; y: number }
+  width?: Width | number
+}
+
 export class PadPrimitiveGrArc extends SxClass {
   static override token = "gr_arc"
   static override parentToken = "primitives"
@@ -15,6 +22,14 @@ export class PadPrimitiveGrArc extends SxClass {
   private _sxEnd?: PadPrimitiveGrArcEnd
   private _sxWidth?: Width
 
+  constructor(params: PadPrimitiveGrArcConstructorParams = {}) {
+    super()
+    if (params.start !== undefined) this.start = params.start
+    if (params.mid !== undefined) this.mid = params.mid
+    if (params.end !== undefined) this.end = params.end
+    if (params.width !== undefined) this.width = params.width
+  }
+
   static override fromSexprPrimitives(
     primitiveSexprs: PrimitiveSExpr[],
   ): PadPrimitiveGrArc {
@@ -66,9 +81,10 @@ export class PadPrimitiveGrArc extends SxClass {
     return this._sxStart
   }
 
-  set start(
-    value: PadPrimitiveGrArcStart | { x: number; y: number } | undefined,
-  ) {
+  set start(value:
+    | PadPrimitiveGrArcStart
+    | { x: number; y: number }
+    | undefined,) {
     this._sxStart = normalizeArcPoint(value, PadPrimitiveGrArcStart)
   }
 
@@ -195,7 +211,9 @@ class PadPrimitiveGrArcStart extends PadPrimitiveGrArcPoint {
     const y = toNumberValue(rawY)
 
     if (x === undefined || y === undefined) {
-      throw new Error("pad primitive gr_arc start expects two numeric arguments")
+      throw new Error(
+        "pad primitive gr_arc start expects two numeric arguments",
+      )
     }
 
     return new PadPrimitiveGrArcStart(x, y)

package/lib/sexpr/classes/PadPrimitiveGrCircle.ts

@@ -6,6 +6,13 @@ import { toNumberValue } from "../utils/toNumberValue"
 
 const SUPPORTED_TOKENS = new Set(["center", "end", "width", "fill"])
 
+export interface PadPrimitiveGrCircleConstructorParams {
+  center?: PadPrimitiveGrCircleCenter | { x: number; y: number }
+  end?: PadPrimitiveGrCircleEnd | { x: number; y: number }
+  width?: Width | number
+  fill?: PadPrimitiveGrCircleFill | boolean
+}
+
 export class PadPrimitiveGrCircle extends SxClass {
   static override token = "gr_circle"
   static override parentToken = "primitives"
@@ -16,6 +23,14 @@ export class PadPrimitiveGrCircle extends SxClass {
   private _sxWidth?: Width
   private _sxFill?: PadPrimitiveGrCircleFill
 
+  constructor(params: PadPrimitiveGrCircleConstructorParams = {}) {
+    super()
+    if (params.center !== undefined) this.center = params.center
+    if (params.end !== undefined) this.end = params.end
+    if (params.width !== undefined) this.width = params.width
+    if (params.fill !== undefined) this.fill = params.fill
+  }
+
   static override fromSexprPrimitives(
     primitiveSexprs: PrimitiveSExpr[],
   ): PadPrimitiveGrCircle {
@@ -66,9 +81,10 @@ export class PadPrimitiveGrCircle extends SxClass {
     return this._sxCenter
   }
 
-  set center(
-    value: PadPrimitiveGrCircleCenter | { x: number; y: number } | undefined,
-  ) {
+  set center(value:
+    | PadPrimitiveGrCircleCenter
+    | { x: number; y: number }
+    | undefined,) {
     this._sxCenter = normalizeCirclePoint(value, PadPrimitiveGrCircleCenter)
   }
 
@@ -76,7 +92,10 @@ export class PadPrimitiveGrCircle extends SxClass {
     return this._sxEnd
   }
 
-  set end(value: PadPrimitiveGrCircleEnd | { x: number; y: number } | undefined) {
+  set end(value:
+    | PadPrimitiveGrCircleEnd
+    | { x: number; y: number }
+    | undefined) {
     this._sxEnd = normalizeCirclePoint(value, PadPrimitiveGrCircleEnd)
   }
 

package/lib/sexpr/classes/PadPrimitives.ts

@@ -80,7 +80,9 @@ export class PadPrimitives extends SxClass {
         continue
       }
 
-      throw new Error(`pad primitives encountered unsupported token "${parsed.token}"`)
+      throw new Error(
+        `pad primitives encountered unsupported token "${parsed.token}"`,
+      )
     }
 
     return primitives

package/lib/sexpr/classes/PadSize.ts

@@ -2,6 +2,11 @@ import { SxClass } from "../base-classes/SxClass"
 import type { PrimitiveSExpr } from "../parseToPrimitiveSExpr"
 import { toNumberValue } from "../utils/toNumberValue"
 
+export type PadSizeInput =
+  | PadSize
+  | [width: number, height: number]
+  | { width: number; height: number }
+
 export class PadSize extends SxClass {
   static override token = "size"
   static override parentToken = "pad"
@@ -16,6 +21,16 @@ export class PadSize extends SxClass {
     this._height = height
   }
 
+  static from(input: PadSizeInput): PadSize {
+    if (input instanceof PadSize) {
+      return input
+    }
+    if (Array.isArray(input)) {
+      return new PadSize(input[0], input[1])
+    }
+    return new PadSize(input.width, input.height)
+  }
+
   static override fromSexprPrimitives(
     primitiveSexprs: PrimitiveSExpr[],
   ): PadSize {

package/lib/sexpr/classes/PadTeardrops.ts

@@ -194,7 +194,9 @@ export class PadTeardrops extends SxClass {
       lines.push(`  (enabled ${this._enabled ? "yes" : "no"})`)
     }
     if (this._allowTwoSegments !== undefined) {
-      lines.push(`  (allow_two_segments ${this._allowTwoSegments ? "yes" : "no"})`)
+      lines.push(
+        `  (allow_two_segments ${this._allowTwoSegments ? "yes" : "no"})`,
+      )
     }
     if (this._preferZoneConnections !== undefined) {
       lines.push(

package/lib/sexpr/classes/PcbGeneral.ts

@@ -22,24 +22,30 @@ export class PcbGeneral extends SxClass {
 
     for (const token of Object.keys(propertyMap)) {
       if (!SINGLE_TOKENS.has(token)) {
-        throw new Error(`general encountered unsupported child token "${token}"`)
+        throw new Error(
+          `general encountered unsupported child token "${token}"`,
+        )
       }
     }
 
     for (const [token, entries] of Object.entries(arrayPropertyMap)) {
       if (!SINGLE_TOKENS.has(token)) {
-        throw new Error(`general encountered unsupported child token "${token}"`)
+        throw new Error(
+          `general encountered unsupported child token "${token}"`,
+        )
       }
       if (entries.length > 1) {
         throw new Error(`general encountered repeated child token "${token}"`)
       }
     }
 
-    general._sxThickness = (arrayPropertyMap.thickness?.[0] as
-      | PcbGeneralThickness
-      | undefined) ?? (propertyMap.thickness as PcbGeneralThickness | undefined)
+    general._sxThickness =
+      (arrayPropertyMap.thickness?.[0] as PcbGeneralThickness | undefined) ??
+      (propertyMap.thickness as PcbGeneralThickness | undefined)
     general._sxLegacyTeardrops =
-      (arrayPropertyMap.legacy_teardrops?.[0] as PcbGeneralLegacyTeardrops | undefined) ??
+      (arrayPropertyMap.legacy_teardrops?.[0] as
+        | PcbGeneralLegacyTeardrops
+        | undefined) ??
       (propertyMap.legacy_teardrops as PcbGeneralLegacyTeardrops | undefined)
 
     return general
@@ -50,7 +56,8 @@ export class PcbGeneral extends SxClass {
   }
 
   set thickness(value: number | undefined) {
-    this._sxThickness = value === undefined ? undefined : new PcbGeneralThickness(value)
+    this._sxThickness =
+      value === undefined ? undefined : new PcbGeneralThickness(value)
   }
 
   get legacyTeardrops(): boolean | undefined {

package/lib/sexpr/classes/PcbLayerDefinition.ts

@@ -85,7 +85,11 @@ export class PcbLayerDefinition extends SxClass {
   }
 
   override getString(): string {
-    if (this._index === undefined || this._name === undefined || this._type === undefined) {
+    if (
+      this._index === undefined ||
+      this._name === undefined ||
+      this._type === undefined
+    ) {
       return "()"
     }
     const tokens = [