@tscircuit/props 0.0.358 → 0.0.360

package/lib/components/fabrication-note-dimension.ts

@@ -0,0 +1,41 @@
+import { distance, length } from "circuit-json"
+import { pcbLayoutProps, type PcbLayoutProps } from "lib/common/layout"
+import { point, type Point } from "lib/common/point"
+import { expectTypesMatch } from "lib/typecheck"
+import { z } from "zod"
+
+const dimensionTarget = z.union([z.string(), point])
+
+export interface FabricationNoteDimensionProps
+  extends Omit<PcbLayoutProps, "pcbX" | "pcbY" | "pcbRotation"> {
+  from: string | Point
+  to: string | Point
+  text?: string
+  offset?: string | number
+  font?: "tscircuit2024"
+  fontSize?: string | number
+  color?: string
+  arrowSize?: string | number
+}
+
+export const fabricationNoteDimensionProps = pcbLayoutProps
+  .omit({ pcbX: true, pcbY: true, pcbRotation: true })
+  .extend({
+    from: dimensionTarget,
+    to: dimensionTarget,
+    text: z.string().optional(),
+    offset: distance.optional(),
+    font: z.enum(["tscircuit2024"]).optional(),
+    fontSize: length.optional(),
+    color: z.string().optional(),
+    arrowSize: distance.optional(),
+  })
+
+expectTypesMatch<
+  FabricationNoteDimensionProps,
+  z.input<typeof fabricationNoteDimensionProps>
+>(true)
+
+export type FabricationNoteDimensionPropsInput = z.input<
+  typeof fabricationNoteDimensionProps
+>

package/lib/components/fabrication-note-text.ts

@@ -1,7 +1,21 @@
 import { length } from "circuit-json"
-import { pcbLayoutProps } from "lib/common/layout"
+import { pcbLayoutProps, type PcbLayoutProps } from "lib/common/layout"
+import { expectTypesMatch } from "lib/typecheck"
 import { z } from "zod"
 
+export interface FabricationNoteTextProps extends PcbLayoutProps {
+  text: string
+  anchorAlignment?:
+    | "center"
+    | "top_left"
+    | "top_right"
+    | "bottom_left"
+    | "bottom_right"
+  font?: "tscircuit2024"
+  fontSize?: string | number
+  color?: string
+}
+
 export const fabricationNoteTextProps = pcbLayoutProps.extend({
   text: z.string(),
   anchorAlignment: z
@@ -11,4 +25,12 @@ export const fabricationNoteTextProps = pcbLayoutProps.extend({
   fontSize: length.optional(),
   color: z.string().optional(),
 })
-export type FabricationNoteTextProps = z.input<typeof fabricationNoteTextProps>
+
+expectTypesMatch<
+  FabricationNoteTextProps,
+  z.input<typeof fabricationNoteTextProps>
+>(true)
+
+export type FabricationNoteTextPropsInput = z.input<
+  typeof fabricationNoteTextProps
+>

package/lib/components/group.ts

@@ -6,6 +6,7 @@ import {
   commonLayoutProps,
   type SupplierPartNumbers,
 } from "lib/common/layout"
+import { ninePointAnchor } from "lib/common/ninePointAnchor"
 import { type Point, point } from "lib/common/point"
 import { expectTypesMatch } from "lib/typecheck"
 import { z } from "zod"
@@ -210,6 +211,10 @@ export interface BaseGroupProps extends CommonLayoutProps, LayoutConfig {
   pcbPaddingRight?: Distance
   pcbPaddingTop?: Distance
   pcbPaddingBottom?: Distance
+  /**
+   * Anchor to use when interpreting pcbX/pcbY relative to pcbPosition
+   */
+  pcbPositionAnchor?: AutocompleteString<z.infer<typeof ninePointAnchor>>
 
   /** @deprecated Use `pcbGrid` */
   grid?: boolean
@@ -325,6 +330,10 @@ export type AutorouterProp =
   | AutorouterConfig
   | AutocompleteString<AutorouterPreset>
 
+const pcbPositionAnchorAutocomplete = z.custom<
+  AutocompleteString<z.infer<typeof ninePointAnchor>>
+>((value) => typeof value === "string")
+
 export const autorouterConfig = z.object({
   serverUrl: z.string().optional(),
   inputFormat: z.enum(["simplified", "circuit-json"]).optional(),
@@ -520,6 +529,7 @@ export const baseGroupProps = commonLayoutProps.extend({
   pcbPaddingRight: length.optional(),
   pcbPaddingTop: length.optional(),
   pcbPaddingBottom: length.optional(),
+  pcbPositionAnchor: pcbPositionAnchorAutocomplete.optional(),
 })
 
 export const partsEngine = z.custom<PartsEngine>((v) => "findPart" in v)

package/lib/components/pcb-note-dimension.ts

@@ -0,0 +1,38 @@
+import { distance, length } from "circuit-json"
+import { pcbLayoutProps, type PcbLayoutProps } from "lib/common/layout"
+import { point, type Point } from "lib/common/point"
+import { expectTypesMatch } from "lib/typecheck"
+import { z } from "zod"
+
+const dimensionTarget = z.union([z.string(), point])
+
+export interface PcbNoteDimensionProps
+  extends Omit<PcbLayoutProps, "pcbX" | "pcbY" | "pcbRotation"> {
+  from: string | Point
+  to: string | Point
+  text?: string
+  offset?: string | number
+  font?: "tscircuit2024"
+  fontSize?: string | number
+  color?: string
+  arrowSize?: string | number
+}
+
+export const pcbNoteDimensionProps = pcbLayoutProps
+  .omit({ pcbX: true, pcbY: true, pcbRotation: true })
+  .extend({
+    from: dimensionTarget,
+    to: dimensionTarget,
+    text: z.string().optional(),
+    offset: distance.optional(),
+    font: z.enum(["tscircuit2024"]).optional(),
+    fontSize: length.optional(),
+    color: z.string().optional(),
+    arrowSize: distance.optional(),
+  })
+
+expectTypesMatch<PcbNoteDimensionProps, z.input<typeof pcbNoteDimensionProps>>(
+  true,
+)
+
+export type PcbNoteDimensionPropsInput = z.input<typeof pcbNoteDimensionProps>

package/lib/components/pcb-note-line.ts

@@ -0,0 +1,31 @@
+import { distance } from "circuit-json"
+import { pcbLayoutProps, type PcbLayoutProps } from "lib/common/layout"
+import { expectTypesMatch } from "lib/typecheck"
+import { z } from "zod"
+
+export interface PcbNoteLineProps
+  extends Omit<PcbLayoutProps, "pcbX" | "pcbY" | "pcbRotation"> {
+  x1: string | number
+  y1: string | number
+  x2: string | number
+  y2: string | number
+  strokeWidth?: string | number
+  color?: string
+  isDashed?: boolean
+}
+
+export const pcbNoteLineProps = pcbLayoutProps
+  .omit({ pcbX: true, pcbY: true, pcbRotation: true })
+  .extend({
+    x1: distance,
+    y1: distance,
+    x2: distance,
+    y2: distance,
+    strokeWidth: distance.optional(),
+    color: z.string().optional(),
+    isDashed: z.boolean().optional(),
+  })
+
+expectTypesMatch<PcbNoteLineProps, z.input<typeof pcbNoteLineProps>>(true)
+
+export type PcbNoteLinePropsInput = z.input<typeof pcbNoteLineProps>

package/lib/components/pcb-note-path.ts

@@ -0,0 +1,27 @@
+import {
+  length,
+  route_hint_point,
+  type RouteHintPointInput,
+} from "circuit-json"
+import { pcbLayoutProps, type PcbLayoutProps } from "lib/common/layout"
+import { expectTypesMatch } from "lib/typecheck"
+import { z } from "zod"
+
+export interface PcbNotePathProps
+  extends Omit<PcbLayoutProps, "pcbX" | "pcbY" | "pcbRotation"> {
+  route: RouteHintPointInput[]
+  strokeWidth?: string | number
+  color?: string
+}
+
+export const pcbNotePathProps = pcbLayoutProps
+  .omit({ pcbX: true, pcbY: true, pcbRotation: true })
+  .extend({
+    route: z.array(route_hint_point),
+    strokeWidth: length.optional(),
+    color: z.string().optional(),
+  })
+
+expectTypesMatch<PcbNotePathProps, z.input<typeof pcbNotePathProps>>(true)
+
+export type PcbNotePathPropsInput = z.input<typeof pcbNotePathProps>

package/lib/components/pcb-note-rect.ts

@@ -0,0 +1,30 @@
+import { distance } from "circuit-json"
+import { pcbLayoutProps, type PcbLayoutProps } from "lib/common/layout"
+import { expectTypesMatch } from "lib/typecheck"
+import { z } from "zod"
+
+export interface PcbNoteRectProps extends Omit<PcbLayoutProps, "pcbRotation"> {
+  width: string | number
+  height: string | number
+  strokeWidth?: string | number
+  isFilled?: boolean
+  hasStroke?: boolean
+  isStrokeDashed?: boolean
+  color?: string
+}
+
+export const pcbNoteRectProps = pcbLayoutProps
+  .omit({ pcbRotation: true })
+  .extend({
+    width: distance,
+    height: distance,
+    strokeWidth: distance.optional(),
+    isFilled: z.boolean().optional(),
+    hasStroke: z.boolean().optional(),
+    isStrokeDashed: z.boolean().optional(),
+    color: z.string().optional(),
+  })
+
+expectTypesMatch<PcbNoteRectProps, z.input<typeof pcbNoteRectProps>>(true)
+
+export type PcbNoteRectPropsInput = z.input<typeof pcbNoteRectProps>

package/lib/components/pcb-note-text.ts

@@ -0,0 +1,31 @@
+import { length } from "circuit-json"
+import { pcbLayoutProps, type PcbLayoutProps } from "lib/common/layout"
+import { expectTypesMatch } from "lib/typecheck"
+import { z } from "zod"
+
+export interface PcbNoteTextProps extends PcbLayoutProps {
+  text: string
+  anchorAlignment?:
+    | "center"
+    | "top_left"
+    | "top_right"
+    | "bottom_left"
+    | "bottom_right"
+  font?: "tscircuit2024"
+  fontSize?: string | number
+  color?: string
+}
+
+export const pcbNoteTextProps = pcbLayoutProps.extend({
+  text: z.string(),
+  anchorAlignment: z
+    .enum(["center", "top_left", "top_right", "bottom_left", "bottom_right"])
+    .default("center"),
+  font: z.enum(["tscircuit2024"]).optional(),
+  fontSize: length.optional(),
+  color: z.string().optional(),
+})
+
+expectTypesMatch<PcbNoteTextProps, z.input<typeof pcbNoteTextProps>>(true)
+
+export type PcbNoteTextPropsInput = z.input<typeof pcbNoteTextProps>

package/lib/index.ts

@@ -57,6 +57,7 @@ export * from "./components/switch"
 export * from "./components/fabrication-note-text"
 export * from "./components/fabrication-note-rect"
 export * from "./components/fabrication-note-path"
+export * from "./components/fabrication-note-dimension"
 export * from "./components/pcb-trace"
 export * from "./components/via"
 export * from "./components/testpoint"
@@ -87,6 +88,11 @@ export * from "./components/silkscreen-rect"
 export * from "./components/silkscreen-circle"
 export * from "./components/trace-hint"
 export * from "./components/port"
+export * from "./components/pcb-note-text"
+export * from "./components/pcb-note-rect"
+export * from "./components/pcb-note-path"
+export * from "./components/pcb-note-line"
+export * from "./components/pcb-note-dimension"
 export * from "./platformConfig"
 export * from "./projectConfig"
 export * from "./utility-types/connections-and-selectors"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tscircuit/props",
-  "version": "0.0.358",
+  "version": "0.0.360",
   "description": "Props for tscircuit builtin component types",
   "main": "dist/index.js",
   "type": "module",