@tscircuit/props 0.0.706 → 0.0.707

package/lib/assembly/explosion/index.ts

@@ -0,0 +1,11 @@
+import { assemblyExplosionMoveProps } from "./move"
+import { assemblyExplosionStageProps } from "./stage"
+
+export * from "./move"
+export * from "./stage"
+
+/** Explosion elements; no separate explosion container is needed. */
+export const assemblyExplosionProps = {
+  stage: assemblyExplosionStageProps,
+  move: assemblyExplosionMoveProps,
+} as const

package/lib/assembly/explosion/move.ts

@@ -0,0 +1,72 @@
+import { type Distance, distance } from "lib/common/distance"
+import { expectTypesMatch } from "lib/typecheck"
+import { z } from "zod"
+
+/** One straight, incremental movement within an explosion stage. */
+export interface AssemblyExplosionMoveProps {
+  /** Parts or subassemblies to move together, relative to the stage owner.
+   * Accepts a comma-separated string or an array; parsed as a nonempty array of
+   * trimmed references. Supply exactly one of targetRefs or targetRef.
+   */
+  targetRefs?: string | string[]
+  /** Single-target compatibility alias for targetRefs. Parsed as targetRefs:
+   * [targetRef]; cannot be combined with targetRefs. React reserves ref.
+   */
+  targetRef?: string
+  /** Signed X displacement in the stage owner's frame, in mm or a unit string.
+   * Omitted axes mean zero in the consumer; parsed props remain omitted.
+   */
+  offX?: Distance
+  /** Signed Y displacement in the stage owner's frame, in mm or a unit string. */
+  offY?: Distance
+  /** Signed Z displacement in the stage owner's frame, in mm or a unit string. */
+  offZ?: Distance
+}
+
+const offset = distance.pipe(z.number().finite())
+const reference = z.string().trim().min(1)
+const references = z
+  .union([
+    z.string().transform((value) => value.split(",")),
+    z.array(z.string()),
+  ])
+  .pipe(z.array(reference).min(1))
+
+export const assemblyExplosionMoveProps = z
+  .object({
+    targetRefs: references.optional(),
+    targetRef: reference.optional(),
+    offX: offset.optional(),
+    offY: offset.optional(),
+    offZ: offset.optional(),
+  })
+  .refine(
+    (move) =>
+      (move.targetRefs !== undefined) !== (move.targetRef !== undefined),
+    {
+      message: "Provide exactly one of targetRefs or targetRef",
+      path: ["targetRefs"],
+    },
+  )
+  .refine(
+    (move) =>
+      move.offX !== undefined ||
+      move.offY !== undefined ||
+      move.offZ !== undefined,
+    {
+      message: "Provide at least one of offX, offY, or offZ",
+      path: ["offX"],
+    },
+  )
+  .transform(({ targetRef, targetRefs, ...move }) => ({
+    ...move,
+    targetRefs: targetRefs ?? [targetRef!],
+  }))
+
+export type AssemblyExplosionMovePropsInput = z.input<
+  typeof assemblyExplosionMoveProps
+>
+
+expectTypesMatch<AssemblyExplosionMoveProps, AssemblyExplosionMovePropsInput>(
+  true,
+)

package/lib/assembly/explosion/stage.ts

@@ -0,0 +1,30 @@
+import { expectTypesMatch } from "lib/typecheck"
+import type { ReactNode } from "react"
+import { z } from "zod"
+
+/** A named explosion stage owned by its containing device or subassembly. */
+export interface AssemblyExplosionStageProps {
+  /** Stable stage identity, unique within the owning assembly. */
+  name: string
+  /** Stage that must execute after this one; qualified names may cross assembly scopes. */
+  nextStageRef?: string
+  /** Stage that must execute before this one; qualified names may cross assembly scopes. */
+  prevStageRef?: string
+  /** Ordered explosion moves; preserved unchanged for the consumer. */
+  children?: ReactNode
+}
+
+export const assemblyExplosionStageProps = z.object({
+  name: z.string().trim().min(1),
+  nextStageRef: z.string().trim().min(1).optional(),
+  prevStageRef: z.string().trim().min(1).optional(),
+  children: z.custom<ReactNode>().optional(),
+})
+
+export type AssemblyExplosionStagePropsInput = z.input<
+  typeof assemblyExplosionStageProps
+>
+
+expectTypesMatch<AssemblyExplosionStageProps, AssemblyExplosionStagePropsInput>(
+  true,
+)

package/lib/assembly/index.ts

@@ -9,6 +9,7 @@ import { assemblyPrintedPartProps } from "./printedpart"
 import { assemblyMotorProps } from "./motor"
 import { assemblyScreenProps } from "./screen"
 import { assemblySubassemblyProps } from "./subassembly"
+import { assemblyExplosionProps } from "./explosion"
 
 export * from "./board-mounting"
 export * from "./bolt"
@@ -22,8 +23,10 @@ export * from "./printedpart"
 export * from "./screen"
 export * from "./subassembly"
 export * from "./cadassembly"
+export * from "./explosion"
 
 export const assemblyProps = {
+  explosion: assemblyExplosionProps,
   bolt: assemblyBoltProps,
   fastener: assemblyFastenerProps,
   cable: assemblyCableProps,

package/package.json

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