@tscircuit/props 0.0.549 → 0.0.550

package/lib/components/ammeter.ts

@@ -0,0 +1,55 @@
+import {
+  type CommonComponentProps,
+  commonComponentProps,
+} from "lib/common/layout"
+import { createConnectionsProp } from "lib/common/connectionsProp"
+import type { Connections } from "lib/utility-types/connections-and-selectors"
+import { expectTypesMatch } from "lib/typecheck"
+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
+}
+
+const hasAmmeterConnectionPair = (
+  connections: Connections<AmmeterPinLabels>,
+) => {
+  return (
+    (connections.pos !== undefined && connections.neg !== undefined) ||
+    (connections.pin1 !== undefined && connections.pin2 !== undefined)
+  )
+}
+
+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(),
+})
+
+export const ammeterPins = ammeterPinLabels
+
+type InferredAmmeterProps = z.input<typeof ammeterProps>
+expectTypesMatch<AmmeterProps, InferredAmmeterProps>(true)

package/lib/index.ts

@@ -95,6 +95,7 @@ export * from "./components/power-source"
 export * from "./components/voltagesource"
 export * from "./components/currentsource"
 export * from "./components/voltageprobe"
+export * from "./components/ammeter"
 export * from "./components/schematic-arc"
 export * from "./components/toolingrail"
 export * from "./components/schematic-box"

package/package.json

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