@tscircuit/props 0.0.554 → 0.0.556

package/lib/common/layout.ts

@@ -261,9 +261,13 @@ export interface CommonComponentProps<PinLabel extends string = string>
   mfn?: string
   manufacturerPartNumber?: string
   /**
-   *This component will be drawn as part of this section e.g. \"Power\
+   * This component will be drawn as part of this section e.g. "Power"
    */
   schSectionName?: string
+  /**
+   * This component will be drawn as part of this sheet e.g. "Main"
+   */
+  schSheetName?: string
 }
 
 export const commonComponentProps = commonLayoutProps
@@ -278,6 +282,12 @@ export const commonComponentProps = commonLayoutProps
       .describe(
         'This component will be drawn as part of this section e.g. "Power"',
       ),
+    schSheetName: z
+      .string()
+      .optional()
+      .describe(
+        'This component will be drawn as part of this sheet e.g. "Main"',
+      ),
     datasheetUrl: url.optional(),
     cadModel: cadModelProp.optional(),
     kicadFootprintMetadata: kicadFootprintMetadata.optional(),

package/lib/components/ammeter.ts

@@ -10,18 +10,14 @@ import { z } from "zod"
 export const ammeterPinLabels = ["pin1", "pin2", "pos", "neg"] as const
 export type AmmeterPinLabels = (typeof ammeterPinLabels)[number]
 
-export interface AmmeterDisplayOptions {
-  label?: string
-  center?: number
-  offsetDivs?: number
-  unitsPerDiv?: number
-}
-
 export interface AmmeterProps<PinLabel extends string = string>
   extends CommonComponentProps<PinLabel> {
   connections: Connections<AmmeterPinLabels>
   color?: string
-  display?: AmmeterDisplayOptions
+  graphDisplayName?: string
+  graphCenter?: number
+  graphOffsetDivs?: number
+  graphUnitsPerDiv?: number
 }
 
 const hasAmmeterConnectionPair = (
@@ -33,20 +29,16 @@ const hasAmmeterConnectionPair = (
   )
 }
 
-export const ammeterDisplayOptions = z.object({
-  label: z.string().optional(),
-  center: z.number().optional(),
-  offsetDivs: z.number().optional(),
-  unitsPerDiv: z.number().optional(),
-})
-
 export const ammeterProps = commonComponentProps.extend({
   connections: createConnectionsProp(ammeterPinLabels).refine(
     hasAmmeterConnectionPair,
     "Ammeter connections must include either pos/neg or pin1/pin2",
   ),
   color: z.string().optional(),
-  display: ammeterDisplayOptions.optional(),
+  graphDisplayName: z.string().optional(),
+  graphCenter: z.number().optional(),
+  graphOffsetDivs: z.number().optional(),
+  graphUnitsPerDiv: z.number().optional(),
 })
 
 export const ammeterPins = ammeterPinLabels

package/lib/components/schematic-sheet.ts

@@ -0,0 +1,18 @@
+import { z } from "zod"
+import { expectTypesMatch } from "lib/typecheck"
+
+export interface SchematicSheetProps {
+  name: string
+  displayName: string
+  children?: any
+}
+
+export const schematicSheetProps = z.object({
+  name: z.string(),
+  displayName: z.string(),
+  children: z.any().optional(),
+})
+
+export type InferredSchematicSheetProps = z.input<typeof schematicSheetProps>
+
+expectTypesMatch<SchematicSheetProps, z.input<typeof schematicSheetProps>>(true)

package/lib/components/voltageprobe.ts

@@ -10,14 +10,10 @@ export interface VoltageProbeProps extends Omit<CommonComponentProps, "name"> {
   connectsTo: string
   referenceTo?: string
   color?: string
-  display?: VoltageProbeDisplayOptions
-}
-
-export interface VoltageProbeDisplayOptions {
-  label?: string
-  center?: number
-  offsetDivs?: number
-  unitsPerDiv?: number
+  graphDisplayName?: string
+  graphCenter?: number
+  graphOffsetDivs?: number
+  graphUnitsPerDiv?: number
 }
 
 export const voltageProbeProps = commonComponentProps
@@ -27,14 +23,10 @@ export const voltageProbeProps = commonComponentProps
     connectsTo: z.string(),
     referenceTo: z.string().optional(),
     color: z.string().optional(),
-    display: z
-      .object({
-        label: z.string().optional(),
-        center: z.number().optional(),
-        offsetDivs: z.number().optional(),
-        unitsPerDiv: z.number().optional(),
-      })
-      .optional(),
+    graphDisplayName: z.string().optional(),
+    graphCenter: z.number().optional(),
+    graphOffsetDivs: z.number().optional(),
+    graphUnitsPerDiv: z.number().optional(),
   })
 
 expectTypesMatch<VoltageProbeProps, z.input<typeof voltageProbeProps>>(true)

package/lib/index.ts

@@ -108,6 +108,7 @@ export * from "./components/schematic-table"
 export * from "./components/schematic-row"
 export * from "./components/schematic-cell"
 export * from "./components/schematic-section"
+export * from "./components/schematic-sheet"
 export * from "./components/copper-text"
 export * from "./components/silkscreen-text"
 export * from "./components/silkscreen-path"

package/package.json

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