@tscircuit/props 0.0.369 → 0.0.371

package/lib/common/layout.ts

@@ -11,11 +11,23 @@ import { type CadModelProp, cadModelProp } from "./cadModel"
 import { type FootprintProp, footprintProp } from "./footprintProp"
 import { type SymbolProp, symbolProp } from "./symbolProp"
 
+export type PcbPositionMode =
+  | "relative_to_group_anchor"
+  | "auto"
+  | "relative_to_board_anchor"
+  | "relative_to_component_anchor"
+
+/** @deprecated Use {@link PcbPositionMode} instead. */
+export type PositionMode = PcbPositionMode
+
 export interface PcbLayoutProps {
   pcbX?: string | number
   pcbY?: string | number
+  pcbOffsetX?: string | number
+  pcbOffsetY?: string | number
   pcbRotation?: string | number
   pcbPositionAnchor?: string
+  pcbPositionMode?: PcbPositionMode
   layer?: LayerRefInput
   pcbMarginTop?: string | number
   pcbMarginRight?: string | number
@@ -36,8 +48,11 @@ export interface PcbLayoutProps {
 export interface CommonLayoutProps {
   pcbX?: string | number
   pcbY?: string | number
+  pcbOffsetX?: string | number
+  pcbOffsetY?: string | number
   pcbRotation?: string | number
   pcbPositionAnchor?: string
+  pcbPositionMode?: PcbPositionMode
 
   pcbMarginTop?: string | number
   pcbMarginRight?: string | number
@@ -80,8 +95,18 @@ export interface CommonLayoutProps {
 export const pcbLayoutProps = z.object({
   pcbX: distance.optional(),
   pcbY: distance.optional(),
+  pcbOffsetX: distance.optional(),
+  pcbOffsetY: distance.optional(),
   pcbRotation: rotation.optional(),
   pcbPositionAnchor: z.string().optional(),
+  pcbPositionMode: z
+    .enum([
+      "relative_to_group_anchor",
+      "auto",
+      "relative_to_board_anchor",
+      "relative_to_component_anchor",
+    ])
+    .optional(),
   layer: layer_ref.optional(),
   pcbMarginTop: distance.optional(),
   pcbMarginRight: distance.optional(),
@@ -98,8 +123,18 @@ expectTypesMatch<PcbLayoutProps, InferredPcbLayoutProps>(true)
 export const commonLayoutProps = z.object({
   pcbX: distance.optional(),
   pcbY: distance.optional(),
+  pcbOffsetX: distance.optional(),
+  pcbOffsetY: distance.optional(),
   pcbRotation: rotation.optional(),
   pcbPositionAnchor: z.string().optional(),
+  pcbPositionMode: z
+    .enum([
+      "relative_to_group_anchor",
+      "auto",
+      "relative_to_board_anchor",
+      "relative_to_component_anchor",
+    ])
+    .optional(),
   pcbMarginTop: distance.optional(),
   pcbMarginRight: distance.optional(),
   pcbMarginBottom: distance.optional(),

package/lib/components/cadmodel.ts

@@ -8,12 +8,16 @@ export interface CadModelProps extends CadModelBase {
   stepUrl?: string
   pcbX?: Distance
   pcbY?: Distance
+  pcbOffsetX?: Distance
+  pcbOffsetY?: Distance
   pcbZ?: Distance
 }
 
 const pcbPosition = z.object({
   pcbX: distance.optional(),
   pcbY: distance.optional(),
+  pcbOffsetX: distance.optional(),
+  pcbOffsetY: distance.optional(),
   pcbZ: distance.optional(),
 })
 

package/lib/components/courtyard-outline.ts

@@ -4,7 +4,13 @@ import { point } from "lib/common/point"
 import { z } from "zod"
 
 export const courtyardOutlineProps = pcbLayoutProps
-  .omit({ pcbX: true, pcbY: true, pcbRotation: true })
+  .omit({
+    pcbX: true,
+    pcbY: true,
+    pcbOffsetX: true,
+    pcbOffsetY: true,
+    pcbRotation: true,
+  })
   .extend({
     outline: z.array(point),
     strokeWidth: length.optional(),

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

@@ -7,7 +7,10 @@ import { z } from "zod"
 const dimensionTarget = z.union([z.string(), point])
 
 export interface FabricationNoteDimensionProps
-  extends Omit<PcbLayoutProps, "pcbX" | "pcbY" | "pcbRotation"> {
+  extends Omit<
+    PcbLayoutProps,
+    "pcbX" | "pcbY" | "pcbOffsetX" | "pcbOffsetY" | "pcbRotation"
+  > {
   from: string | Point
   to: string | Point
   text?: string
@@ -19,7 +22,13 @@ export interface FabricationNoteDimensionProps
 }
 
 export const fabricationNoteDimensionProps = pcbLayoutProps
-  .omit({ pcbX: true, pcbY: true, pcbRotation: true })
+  .omit({
+    pcbX: true,
+    pcbY: true,
+    pcbOffsetX: true,
+    pcbOffsetY: true,
+    pcbRotation: true,
+  })
   .extend({
     from: dimensionTarget,
     to: dimensionTarget,

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

@@ -3,7 +3,13 @@ import { pcbLayoutProps } from "lib/common/layout"
 import { z } from "zod"
 
 export const fabricationNotePathProps = pcbLayoutProps
-  .omit({ pcbX: true, pcbY: true, pcbRotation: true })
+  .omit({
+    pcbX: true,
+    pcbY: true,
+    pcbOffsetX: true,
+    pcbOffsetY: true,
+    pcbRotation: true,
+  })
   .extend({
     route: z.array(route_hint_point),
     strokeWidth: length.optional(),

package/lib/components/group.ts

@@ -212,7 +212,7 @@ export interface BaseGroupProps extends CommonLayoutProps, LayoutConfig {
   pcbPaddingTop?: Distance
   pcbPaddingBottom?: Distance
   /**
-   * Anchor to use when interpreting pcbX/pcbY relative to pcbPosition
+   * Anchor to use when interpreting pcbX/pcbY/pcbOffsetX/pcbOffsetY relative to pcbPosition
    */
   pcbPositionAnchor?: AutocompleteString<z.infer<typeof ninePointAnchor>>
 

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

@@ -7,7 +7,10 @@ import { z } from "zod"
 const dimensionTarget = z.union([z.string(), point])
 
 export interface PcbNoteDimensionProps
-  extends Omit<PcbLayoutProps, "pcbX" | "pcbY" | "pcbRotation"> {
+  extends Omit<
+    PcbLayoutProps,
+    "pcbX" | "pcbY" | "pcbOffsetX" | "pcbOffsetY" | "pcbRotation"
+  > {
   from: string | Point
   to: string | Point
   text?: string
@@ -19,7 +22,13 @@ export interface PcbNoteDimensionProps
 }
 
 export const pcbNoteDimensionProps = pcbLayoutProps
-  .omit({ pcbX: true, pcbY: true, pcbRotation: true })
+  .omit({
+    pcbX: true,
+    pcbY: true,
+    pcbOffsetX: true,
+    pcbOffsetY: true,
+    pcbRotation: true,
+  })
   .extend({
     from: dimensionTarget,
     to: dimensionTarget,

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

@@ -4,7 +4,10 @@ import { expectTypesMatch } from "lib/typecheck"
 import { z } from "zod"
 
 export interface PcbNoteLineProps
-  extends Omit<PcbLayoutProps, "pcbX" | "pcbY" | "pcbRotation"> {
+  extends Omit<
+    PcbLayoutProps,
+    "pcbX" | "pcbY" | "pcbOffsetX" | "pcbOffsetY" | "pcbRotation"
+  > {
   x1: string | number
   y1: string | number
   x2: string | number
@@ -15,7 +18,13 @@ export interface PcbNoteLineProps
 }
 
 export const pcbNoteLineProps = pcbLayoutProps
-  .omit({ pcbX: true, pcbY: true, pcbRotation: true })
+  .omit({
+    pcbX: true,
+    pcbY: true,
+    pcbOffsetX: true,
+    pcbOffsetY: true,
+    pcbRotation: true,
+  })
   .extend({
     x1: distance,
     y1: distance,

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

@@ -8,14 +8,23 @@ import { expectTypesMatch } from "lib/typecheck"
 import { z } from "zod"
 
 export interface PcbNotePathProps
-  extends Omit<PcbLayoutProps, "pcbX" | "pcbY" | "pcbRotation"> {
+  extends Omit<
+    PcbLayoutProps,
+    "pcbX" | "pcbY" | "pcbOffsetX" | "pcbOffsetY" | "pcbRotation"
+  > {
   route: RouteHintPointInput[]
   strokeWidth?: string | number
   color?: string
 }
 
 export const pcbNotePathProps = pcbLayoutProps
-  .omit({ pcbX: true, pcbY: true, pcbRotation: true })
+  .omit({
+    pcbX: true,
+    pcbY: true,
+    pcbOffsetX: true,
+    pcbOffsetY: true,
+    pcbRotation: true,
+  })
   .extend({
     route: z.array(route_hint_point),
     strokeWidth: length.optional(),

package/lib/components/silkscreen-line.ts

@@ -3,7 +3,13 @@ import { pcbLayoutProps } from "lib/common/layout"
 import type { z } from "zod"
 
 export const silkscreenLineProps = pcbLayoutProps
-  .omit({ pcbX: true, pcbY: true, pcbRotation: true })
+  .omit({
+    pcbX: true,
+    pcbY: true,
+    pcbOffsetX: true,
+    pcbOffsetY: true,
+    pcbRotation: true,
+  })
   .extend({
     strokeWidth: distance,
     x1: distance,

package/lib/components/silkscreen-path.ts

@@ -3,7 +3,13 @@ import { pcbLayoutProps } from "lib/common/layout"
 import { z } from "zod"
 
 export const silkscreenPathProps = pcbLayoutProps
-  .omit({ pcbX: true, pcbY: true, pcbRotation: true })
+  .omit({
+    pcbX: true,
+    pcbY: true,
+    pcbOffsetX: true,
+    pcbOffsetY: true,
+    pcbRotation: true,
+  })
   .extend({
     route: z.array(route_hint_point),
     strokeWidth: length.optional(),

package/lib/platformConfig.ts

@@ -62,6 +62,7 @@ export interface PlatformConfig {
   url?: string
   printBoardInformationToSilkscreen?: boolean
   includeBoardFiles?: string[]
+  snapshotsDir?: string
 
   pcbDisabled?: boolean
   schematicDisabled?: boolean
@@ -155,6 +156,12 @@ export const platformConfig = z.object({
       'The board files to automatically build with "tsci build", defaults to ["**/*.circuit.tsx"]. Can be an array of files or globs',
     )
     .optional(),
+  snapshotsDir: z
+    .string()
+    .describe(
+      'The directory where snapshots are stored for "tsci snapshot", defaults to "tests/__snapshots__"',
+    )
+    .optional(),
   localCacheEngine: z.any().optional(),
   pcbDisabled: z.boolean().optional(),
   schematicDisabled: z.boolean().optional(),

package/lib/projectConfig.ts

@@ -11,6 +11,7 @@ export interface ProjectConfig
     | "url"
     | "printBoardInformationToSilkscreen"
     | "includeBoardFiles"
+    | "snapshotsDir"
   > {}
 
 const platformConfigObject = platformConfig as z.ZodObject<any>
@@ -22,6 +23,7 @@ export const projectConfig = platformConfigObject.pick({
   url: true,
   printBoardInformationToSilkscreen: true,
   includeBoardFiles: true,
+  snapshotsDir: true,
 }) as z.ZodType<ProjectConfig>
 
 expectTypesMatch<ProjectConfig, z.infer<typeof projectConfig>>(true)

package/package.json

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