@tscircuit/footprinter 0.0.23 → 0.0.25

package/src/helpers/passive-fn.ts

@@ -1,175 +0,0 @@
-import type { AnySoupElement } from "@tscircuit/soup"
-import { rectpad } from "../helpers/rectpad"
-import mm from "@tscircuit/mm"
-import { platedhole } from "./platedhole"
-
-type StandardSize = {
-  imperial: string
-  metric: string
-  Z_mm_min: number
-  G_mm_min: number
-  X_mm_min: number
-  C_mm_ref: number
-}
-
-// https://www.worthingtonassembly.com/perfect-0201-footprint
-// https://static1.squarespace.com/static/54982a02e4b02e9f5e5d9ca7/t/660c692f69a0d83a4afecdf0/1712089391915/Discrete+Component+Footprints.pdf
-// https://page.venkel.com/hubfs/Resources/Technical/Resistors%20Landing%20Pattern.pdf
-const sizes = [
-  {
-    imperial: "01005",
-    metric: "0402",
-    Z_mm_min: 0.58,
-    G_mm_min: 0.18,
-    X_mm_min: 0.21,
-    C_mm_ref: 0.038,
-  },
-  {
-    imperial: "0201",
-    metric: "0603",
-    Z_mm_min: 0.9,
-    G_mm_min: 0.3,
-    X_mm_min: 0.3,
-    C_mm_ref: 0.6,
-  },
-  {
-    imperial: "0402",
-    metric: "1005",
-    Z_mm_min: 1.6,
-    G_mm_min: 0.4,
-    X_mm_min: 0.7,
-    C_mm_ref: 1,
-  },
-  {
-    imperial: "0603",
-    metric: "1608",
-    Z_mm_min: 2.6,
-    G_mm_min: 0.6,
-    X_mm_min: 1.0,
-    C_mm_ref: 1.7,
-  },
-  {
-    imperial: "0805",
-    metric: "2012",
-    Z_mm_min: 3.0,
-    G_mm_min: 0.6,
-    X_mm_min: 1.2,
-    C_mm_ref: 1.9,
-  },
-  {
-    imperial: "1206",
-    metric: "3216",
-    Z_mm_min: 4.2,
-    G_mm_min: 1.2,
-    X_mm_min: 1.4,
-    C_mm_ref: 2.8,
-  },
-  {
-    imperial: "1210",
-    metric: "3225",
-    Z_mm_min: 4.2,
-    G_mm_min: 1.2,
-    X_mm_min: 2.4,
-    C_mm_ref: 2.8,
-  },
-  {
-    imperial: "2010",
-    metric: "5025",
-    Z_mm_min: 6.0,
-    G_mm_min: 2.6,
-    X_mm_min: 2.4,
-    C_mm_ref: 4.4,
-  },
-  {
-    imperial: "2512",
-    metric: "6332",
-    Z_mm_min: 7.2,
-    G_mm_min: 3.8,
-    X_mm_min: 3.0,
-    C_mm_ref: 5.6,
-  },
-]
-const metricMap: Record<string, StandardSize> = sizes.reduce((acc: any, s) => {
-  acc[s.metric] = s
-  return acc
-}, {})
-const imperialMap: Record<string, StandardSize> = sizes.reduce(
-  (acc: any, s) => {
-    acc[s.imperial] = s
-    return acc
-  },
-  {}
-)
-
-export type PassiveDef = {
-  tht: boolean
-  p: number
-  pw?: number
-  ph?: number
-  metric?: string
-  imperial?: string
-  w?: number
-  h?: number
-}
-
-const deriveXFromH = (h: number) => 0.079 * h ** 2 + 0.94 * h - 0.009
-const deriveZFromW = (w: number) => 1.09 * w + 0.6
-const deriveGFromW = (w: number) => 0.59 * w - 0.31
-const deriveCFromW = (w: number) => -0.01 * w ** 2 + 0.94 * w + 0.03
-
-export const passive = (params: PassiveDef): AnySoupElement[] => {
-  let { tht, p, pw, ph, metric, imperial, w, h } = params
-
-  if (typeof w === "string") w = mm(w)
-  if (typeof h === "string") h = mm(h)
-  if (typeof p === "string") p = mm(p)
-  if (typeof pw === "string") pw = mm(pw)
-  if (typeof ph === "string") ph = mm(ph)
-
-  if (h! > w!) {
-    throw new Error(
-      "height cannot be greater than width (rotated footprint not yet implemented)"
-    )
-  }
-
-  /** standard size */
-  let sz: StandardSize | undefined
-  if (metric) {
-    sz = metricMap[metric]
-  }
-
-  if (imperial) {
-    sz = imperialMap[imperial]
-  }
-
-  if (!sz && w && h && !pw && !ph) {
-    sz = {
-      imperial: "custom",
-      metric: "custom",
-      Z_mm_min: deriveZFromW(w),
-      G_mm_min: deriveGFromW(w),
-      X_mm_min: deriveXFromH(h),
-      C_mm_ref: deriveCFromW(w),
-    }
-  }
-
-  if (sz) {
-    w = sz.Z_mm_min
-    h = sz.X_mm_min
-    p = sz.C_mm_ref
-    pw = (sz.Z_mm_min - sz.G_mm_min) / 2
-    ph = (sz.Z_mm_min - sz.G_mm_min) / 2
-  }
-
-  if (pw === undefined) throw new Error(`could not infer pad width`)
-  if (ph === undefined) throw new Error(`could not infer pad width`)
-
-  if (tht) {
-    return [
-      platedhole(1, -p / 2, 0, pw, (pw * 1) / 0.8),
-      platedhole(2, -p / 2, 0, pw, (pw * 1) / 0.8),
-    ]
-  } else {
-    return [rectpad(1, -p / 2, 0, pw, ph), rectpad(2, p / 2, 0, pw, ph)]
-  }
-}

package/src/helpers/platedhole.ts

@@ -1,21 +0,0 @@
-import type { PCBPlatedHole, PCBSMTPad } from "@tscircuit/soup"
-import { mm } from "@tscircuit/mm"
-
-export const platedhole = (
-  pn: number,
-  x: number,
-  y: number,
-  id: number | string,
-  od: number | string
-): PCBPlatedHole => {
-  return {
-    type: "pcb_plated_hole",
-    x,
-    y,
-    hole_diameter: mm(id),
-    outer_diameter: mm(od),
-    pcb_port_id: "",
-    layers: ["top", "bottom"],
-    port_hints: [pn.toString()],
-  }
-}

package/src/helpers/rectpad.ts

@@ -1,22 +0,0 @@
-import type { PCBSMTPad } from "@tscircuit/soup"
-export const rectpad = (
-  pn: number | Array<string | number>,
-  x: number,
-  y: number,
-  w: number,
-  h: number
-): PCBSMTPad => {
-  return {
-    type: "pcb_smtpad",
-    x,
-    y,
-    width: w,
-    height: h,
-    layer: "top",
-    shape: "rect",
-    pcb_smtpad_id: "",
-    port_hints: Array.isArray(pn)
-      ? pn.map((item) => item.toString())
-      : [pn.toString()],
-  }
-}

package/src/helpers/u-curve.ts

@@ -1,6 +0,0 @@
-export const u_curve = Array.from({ length: 9 }, (_, i) =>
-  Math.cos((i / 8) * Math.PI - Math.PI)
-).map((x) => ({
-  x,
-  y: -Math.sqrt(1 - x ** 2),
-}))

package/src/helpers/zod/ALPHABET.ts

@@ -1 +0,0 @@
-export const ALPHABET = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"

package/src/helpers/zod/dim-2d.ts

@@ -1,17 +0,0 @@
-import { z } from "zod"
-
-export const dim2d = z
-  .string()
-  .transform((a) => {
-    const [x, y] = a.split(/[x ]/)
-    return {
-      x: parseFloat(x),
-      y: parseFloat(y),
-    }
-  })
-  .pipe(
-    z.object({
-      x: z.number(),
-      y: z.number(),
-    })
-  )

package/src/helpers/zod/function-call.ts

@@ -1,16 +0,0 @@
-import { z } from "zod"
-
-export const function_call = z
-  .string()
-  .or(z.array(z.any()))
-  .transform((a) => {
-    if (Array.isArray(a)) return a
-    if (a.startsWith("(") && a.endsWith(")")) {
-      a = a.slice(1, -1)
-    }
-    return a.split(",").map((v) => {
-      const numVal = Number(v)
-      return isNaN(numVal) ? v : numVal
-    })
-  })
-  .pipe(z.array(z.string().or(z.number())))

package/src/helpers/zod/now-defined.ts

@@ -1,2 +0,0 @@
-/* Define a utility type to make certain keys required */
-export type NowDefined<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>

package/src/helpers/zod/pin-order-specifier.ts

@@ -1,13 +0,0 @@
-import { z } from "zod"
-export const pin_order_specifier = z.enum([
-  "leftside",
-  "topside",
-  "rightside",
-  "bottomside",
-  "toppin",
-  "bottompin",
-  "leftpin",
-  "rightpin",
-])
-
-export type PinOrderSpecifier = z.infer<typeof pin_order_specifier>

package/src/index.ts

@@ -1 +0,0 @@
-export * from "./footprinter"

package/tests/bga.test.ts

@@ -1,49 +0,0 @@
-import test from "ava"
-import { fp } from "../src/footprinter"
-import { AnySoupElement } from "@tscircuit/soup"
-import { toPinPositionString } from "./fixtures"
-
-test("bga footprint", (t) => {
-  const soup = fp()
-    .bga(8)
-    .w("4mm")
-    .h("4mm")
-    .grid("3x3")
-    .missing("center")
-    .p(1)
-    .soup()
-  // 16pins, 4mm x 4mm, 8x8 grid, 1.27mm pitch
-  const ps = toPinPositionString(soup)
-
-  t.is(
-    ps,
-    `
-1 : -1.00  1.00
-2 :  0.00  1.00
-3 :  1.00  1.00
-4 : -1.00  0.00
-5 :  1.00  0.00
-6 : -1.00 -1.00
-7 :  0.00 -1.00
-8 :  1.00 -1.00
-  `.trim()
-  )
-})
-
-test("bga7_w8_h8_grid3x3_p1_missing(center,B1)", (t) => {
-  const soup = fp.string("bga7_w8_h8_grid3x3_p1_missing(center,B1)").soup()
-  const ps = toPinPositionString(soup)
-
-  t.is(
-    ps,
-    `
-1 : -1.00  1.00
-2 :  0.00  1.00
-3 :  1.00  1.00
-4 :  1.00  0.00
-5 : -1.00 -1.00
-6 :  0.00 -1.00
-7 :  1.00 -1.00
-  `.trim()
-  )
-})

package/tests/cap.test.ts

@@ -1,30 +0,0 @@
-import test from "ava"
-import { fp } from "../src/footprinter"
-import { AnySoupElement } from "@tscircuit/soup"
-import { toPinPositionString } from "./fixtures"
-
-test("cap footprint", (t) => {
-  const soup = fp().cap().imperial("0402").soup()
-  const ps = toPinPositionString(soup)
-
-  t.is(
-    ps,
-    `
-1 : -0.50  0.00
-2 :  0.50  0.00
-  `.trim()
-  )
-})
-
-test("cap_imperial0402", (t) => {
-  const soup = fp.string("cap_imperial0402").soup()
-  const ps = toPinPositionString(soup)
-
-  t.is(
-    ps,
-    `
-1 : -0.50  0.00
-2 :  0.50  0.00
-  `.trim()
-  )
-})

package/tests/dip.test.ts

@@ -1,45 +0,0 @@
-import test from "ava"
-import { fp } from "../src/footprinter"
-import type { AnySoupElement } from "@tscircuit/soup"
-import { getTestFixture, toPinPositionString } from "./fixtures"
-
-test("dip params", (t) => {
-  t.deepEqual(fp().dip(4).w(7.62).params(), {
-    dip: true,
-    num_pins: 4,
-    w: 7.62,
-  })
-})
-
-test("dip footprint", (t) => {
-  const soup = fp().dip(4).w(4).p(2).soup()
-  const ps = toPinPositionString(soup)
-
-  t.is(
-    ps,
-    `
-1 : -2.00  1.00
-2 : -2.00 -1.00
-3 :  2.00 -1.00
-4 :  2.00  1.00
-  `.trim()
-  )
-})
-
-test("dip4_w3.00mm", async (t) => {
-  const { fp, logSoup } = await getTestFixture(t)
-  const soup = fp.string("dip4_w3.00mm").soup()
-  const ps = toPinPositionString(soup)
-
-  t.is(
-    ps,
-    `
-1 : -1.50  1.27
-2 : -1.50 -1.27
-3 :  1.50 -1.27
-4 :  1.50  1.27
-  `.trim()
-  )
-
-  await logSoup(soup)
-})

package/tests/fixtures/get-test-fixture.ts

@@ -1,20 +0,0 @@
-import type { ExecutionContext } from "ava"
-import { fp } from "../../src"
-import { logSoup } from "@tscircuit/log-soup"
-import type { AnySoupElement } from "@tscircuit/soup"
-
-export const getTestFixture = async (t: ExecutionContext) => {
-  return {
-    fp,
-    logSoup: (soup: AnySoupElement[]) => {
-      if (process.env.CI) return
-      if (process.env.FULL_RUN) return
-      return logSoup(`footprinter: ${t.title}`, soup)
-    },
-    logSoupWithPrefix: (prefix: string, soup: AnySoupElement[]) => {
-      if (process.env.CI) return
-      if (process.env.FULL_RUN) return
-      return logSoup(`footprinter: ${t.title} ${prefix}`, soup)
-    },
-  }
-}

package/tests/fixtures/index.ts

@@ -1,32 +0,0 @@
-import type { AnySoupElement } from "@tscircuit/soup"
-
-export { getTestFixture } from "./get-test-fixture"
-
-export const toPinPositionString = (soup: AnySoupElement[]) => {
-  return soup
-    .map((e: AnySoupElement) => {
-      if (e.type === "pcb_plated_hole") {
-        return {
-          x: e.x,
-          y: e.y,
-          pn: e.port_hints?.[0],
-        }
-      } else if (e.type === "pcb_smtpad") {
-        return {
-          x: e.x,
-          y: e.y,
-          pn: e.port_hints?.[0],
-        }
-      }
-      // TODO other types
-    })
-    .filter(Boolean)
-    .sort((a: any, b: any) => a.pn - b.pn)
-    .map(
-      (e: any) =>
-        `${e.pn.padEnd(2)}: ${e.x.toFixed(2).padStart(5)} ${e.y
-          .toFixed(2)
-          .padStart(5)}`
-    )
-    .join("\n")
-}

package/tests/mlp.test.ts

@@ -1,10 +0,0 @@
-import test from "ava"
-import { getTestFixture, toPinPositionString } from "./fixtures"
-
-test("mlp16_w4_h4_p0.5mm", async (t) => {
-  const { fp, logSoup } = await getTestFixture(t)
-  const soup = fp.string("mlp16_w4_h4_p0.5mm").soup()
-
-  await logSoup(soup)
-  t.pass()
-})

package/tests/qfn.test.ts

@@ -1,10 +0,0 @@
-import test from "ava"
-import { getTestFixture, toPinPositionString } from "./fixtures"
-
-test("qfn16_w4_h4_p0.65mm", async (t) => {
-  const { fp, logSoup } = await getTestFixture(t)
-  const soup = fp.string("qfn16_w4_h4_p0.65mm").soup()
-
-  await logSoup(soup)
-  t.pass()
-})

package/tests/qfp.test.ts

@@ -1,18 +0,0 @@
-import test from "ava"
-import { getTestFixture, toPinPositionString } from "./fixtures"
-
-test("qfp48_w14_p1mm", async (t) => {
-  const { fp, logSoup } = await getTestFixture(t)
-  const soup = fp.string("qfp48_w14_p1mm").soup()
-
-  await logSoup(soup)
-  t.pass()
-})
-
-test("qfp48_w14_p1mm_startingpin(topside,leftpin)", async (t) => {
-  const { fp, logSoup } = await getTestFixture(t)
-  const soup = fp.string("qfp48_w14_p1mm_startingpin(topside,leftpin)").soup()
-
-  await logSoup(soup)
-  t.pass()
-})

package/tests/quad.test.ts

@@ -1,24 +0,0 @@
-import test from "ava"
-import { fp } from "../src/footprinter"
-import type { AnySoupElement } from "@tscircuit/soup"
-import { getTestFixture, toPinPositionString } from "./fixtures"
-
-test("quad16_w4_l4_p0.4_pw0.25_pl0.4", async (t) => {
-  const { fp, logSoup } = await getTestFixture(t)
-  const soup = fp.string("quad16_w4_l4_p0.4_pw0.25_pl0.4").soup()
-
-  await logSoup(soup)
-  t.pass()
-})
-
-test("quad16_w4_l4_p0.4_pw0.25_pl0.4_thermalpad_startingpin(bottomside,leftpin)", async (t) => {
-  const { fp, logSoup } = await getTestFixture(t)
-  const soup = fp
-    .string(
-      "quad16_w4_l4_p0.4_pw0.25_pl0.4_thermalpad_startingpin(bottomside,leftpin)"
-    )
-    .soup()
-
-  await logSoup(soup)
-  t.pass()
-})

package/tests/res.test.ts

@@ -1,11 +0,0 @@
-import test from "ava"
-import { getTestFixture } from "tests/fixtures/get-test-fixture"
-import { su } from "@tscircuit/soup-util"
-
-test("res_imperial0402", async (t) => {
-  const { fp } = await getTestFixture(t)
-  const soup = fp.string("res_imperial0402").soup()
-
-  t.is(su(soup).pcb_smtpad.list().length, 2)
-  t.is(su(soup).pcb_plated_hole.list().length, 0)
-})

package/tests/slop/slop1.test.ts

@@ -1,46 +0,0 @@
-import test from "ava"
-import { getTestFixture } from "../fixtures"
-import type { AnySoupElement } from "@tscircuit/soup"
-
-/**
- * Slop is an underdefined definition.
- */
-export const SLOP_LIST = [
-  "dip3",
-  "bga64",
-  "bga48",
-  "bga48_grid8x8",
-  "bga48_p2_pad0.2",
-]
-
-test("slop1", async (t) => {
-  const { fp, logSoupWithPrefix } = await getTestFixture(t)
-
-  const soups: AnySoupElement[][] = []
-  const failures: Array<{
-    slop_string: string
-    error: any
-  }> = []
-
-  for (const slop of SLOP_LIST) {
-    try {
-      const soup = fp.string(slop).soup()
-      soups.push(soup)
-      if (slop === SLOP_LIST[SLOP_LIST.length - 1]) {
-        await logSoupWithPrefix(slop, soup)
-      }
-    } catch (e: any) {
-      failures.push({
-        slop_string: slop,
-        error: e,
-      })
-      throw e
-    }
-  }
-
-  if (failures.length > 0) {
-    t.fail(`Failures:\n${failures.map((f) => f.slop_string).join("\n")}`)
-  } else {
-    t.pass()
-  }
-})

package/tests/soic.test.ts

@@ -1,11 +0,0 @@
-import test from "ava"
-import { getTestFixture } from "tests/fixtures/get-test-fixture"
-import { su } from "@tscircuit/soup-util"
-
-test("soic8_w5.3mm_p1.27mm", async (t) => {
-  const { fp, logSoup } = await getTestFixture(t)
-  const soup = fp.string("soic8_w5.3mm_p1.27mm").soup()
-
-  t.is(su(soup).pcb_plated_hole.list().length, 8)
-  await logSoup(soup)
-})

package/tsconfig.json

@@ -1,26 +0,0 @@
-{
-  "compilerOptions": {
-    // Base Options recommended for all projects
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "target": "es2022",
-    "allowJs": true,
-    "baseUrl": ".",
-    "resolveJsonModule": true,
-    "moduleDetection": "force",
-    "isolatedModules": true,
-    "verbatimModuleSyntax": true,
-    // Enable strict type checking so you can catch bugs early
-    "strict": true,
-    "noImplicitAny": false,
-    "noUncheckedIndexedAccess": true,
-    "noImplicitOverride": true,
-    // We are not transpiling, so preserve our source code and do not emit files
-    "module": "preserve",
-    "noEmit": true,
-    "lib": ["es2022"]
-  },
-  // Include the necessary files for your project
-  "include": ["**/*.ts", "**/*.tsx"],
-  "exclude": ["node_modules"]
-}