@tscircuit/schematic-viewer 0.0.1 → 0.0.3

package/dist/lib/hooks/index.d.ts

@@ -0,0 +1 @@
+export { default as useMaybePromise } from './use-maybe-promise.js';

package/dist/lib/hooks/use-maybe-promise.d.ts

@@ -0,0 +1,3 @@
+declare const useMaybePromise: <T>(promise: T | Promise<T>) => T;
+
+export { useMaybePromise as default, useMaybePromise };

package/dist/lib/render-context/index.d.ts

@@ -0,0 +1,10 @@
+import * as zustand from 'zustand';
+import { Matrix } from 'transformation-matrix';
+
+interface RenderContextState {
+    camera_transform: Matrix;
+}
+declare const useRenderContext: zustand.UseBoundStore<zustand.StoreApi<RenderContextState>>;
+declare const useCameraTransform: () => Matrix;
+
+export { useCameraTransform, useRenderContext };

package/dist/lib/types/core.d.ts

@@ -0,0 +1,149 @@
+import { SourceComponent } from './source-component.js';
+import './util.js';
+
+interface SchematicConfig {
+    type: "schematic_config";
+}
+interface Point {
+    x: number;
+    y: number;
+}
+interface Size {
+    width: number;
+    height: number;
+}
+interface SourceConfig {
+    type: "source_config";
+}
+interface SchematicGroup {
+    type: "schematic_group";
+    schematic_group_id: string;
+    source_group_id: string;
+    center: Point;
+    size: Size;
+    children_schematic_component_ids: string[];
+    children_schematic_trace_ids: string[];
+}
+interface SchematicComponent {
+    type: "schematic_component";
+    rotation: number;
+    size: Size;
+    center: Point;
+    source_component_id: string;
+    schematic_component_id: string;
+    port_arrangement?: {
+        left_size: number;
+        right_size: number;
+        top_size?: number;
+        bottom_size?: number;
+    };
+    port_labels?: {
+        [port_number: string]: string;
+    };
+}
+interface SchematicTrace {
+    type: "schematic_trace";
+    schematic_trace_id: string;
+    source_trace_id: string;
+    edges: Array<{
+        from: {
+            x: number;
+            y: number;
+        };
+        to: {
+            x: number;
+            y: number;
+        };
+        from_schematic_port_id?: string;
+        to_schematic_port_id?: string;
+    }>;
+}
+interface SchematicText {
+    type: "schematic_text";
+    schematic_component_id: string;
+    schematic_text_id: string;
+    text: string;
+    position: Point;
+    anchor: "center" | "left" | "right" | "top" | "bottom";
+}
+interface SchematicPort {
+    type: "schematic_port";
+    schematic_port_id: string;
+    source_port_id: string;
+    center: Point;
+    facing_direction?: "up" | "down" | "left" | "right";
+}
+interface PCBTrace {
+    type: "pcb_trace";
+    source_trace_id: string;
+    pcb_trace_id: string;
+    route: Array<{
+        x: number;
+        y: number;
+        strokeWidth: number;
+        cap: "butt" | "round" | "square";
+        start_pcb_port_id?: string;
+        end_pcb_port_id?: string;
+    }>;
+}
+interface PCBComponent {
+    type: "pcb_component";
+    pcb_component_id: string;
+    source_component_id: string;
+}
+interface PCBPort {
+    type: "pcb_port";
+    pcb_port_id: string;
+    source_port_id: string;
+}
+interface PCBGroup {
+    type: "pcb_group";
+    source_group_id: string;
+}
+interface PCBConfig {
+    type: "pcb_config";
+    dimension_unit: "mm";
+}
+interface SourceTrace {
+    type: "source_trace";
+    source_trace_id: string;
+    connected_source_port_ids: string[];
+}
+interface SourceGroup {
+    type: "source_group";
+    source_group_id: string;
+    name: string;
+    children_source_component_ids: string[];
+}
+interface SourcePort {
+    type: "source_port";
+    name: string;
+    source_port_id: string;
+    source_component_id: string;
+}
+interface Project {
+    type: "project";
+    schematic_config: SchematicConfig;
+    schematic_components: SchematicComponent[];
+    schematic_groups: SchematicGroup[];
+    schematic_traces: SchematicTrace[];
+    schematic_texts: SchematicText[];
+    schematic_ports: SchematicPort[];
+    pcb_config: PCBConfig;
+    pcb_groups: PCBGroup[];
+    pcb_components: PCBComponent[];
+    pcb_traces: PCBTrace[];
+    pcb_ports: PCBPort[];
+    source_config: SourceConfig;
+    source_traces: SourceTrace[];
+    source_groups: SourceGroup[];
+    source_components: SourceComponent[];
+    source_ports: SourcePort[];
+}
+declare type AnyElement = Project | SourceConfig | SourceComponent | SourceGroup | SourceTrace | SourcePort | PCBTrace | PCBComponent | PCBGroup | PCBConfig | PCBPort | SchematicGroup | SchematicComponent | SchematicTrace | SchematicConfig | SchematicPort | SchematicText;
+declare type ElementType = AnyElement["type"];
+declare type ElementOfType<T extends ElementType> = Extract<AnyElement, {
+    type: T;
+}>;
+
+export { AnyElement, ElementOfType, ElementType, PCBComponent, PCBConfig, PCBGroup, PCBPort, PCBTrace, Point, Project, SchematicComponent, SchematicConfig, SchematicGroup, SchematicPort, SchematicText, SchematicTrace, Size, SourceConfig, SourceGroup, SourcePort, SourceTrace };

package/dist/lib/types/index.d.ts

@@ -0,0 +1,4 @@
+export { AnyElement, ElementOfType, ElementType, PCBComponent, PCBConfig, PCBGroup, PCBPort, PCBTrace, Point, Project, SchematicComponent, SchematicConfig, SchematicGroup, SchematicPort, SchematicText, SchematicTrace, Size, SourceConfig, SourceGroup, SourcePort, SourceTrace } from './core.js';
+export { AnySourceComponent, LightEmittingDiode, SimpleBug, SimpleCapacitor, SimpleDiode, SimpleGround, SimpleInductor, SimplePowerSource, SimpleResistor, SourceComponent, SourceComponentBase, SourceComponentFType } from './source-component.js';
+export { NumberWithAnyUnit, NumberWithUnit, SIPrefix, Unit, UnitAbbreviations, UnitOrAbbreviation } from './util.js';
+export { RouteSolver } from './route-solver.js';

package/dist/lib/types/route-solver.d.ts

@@ -0,0 +1,24 @@
+declare type RouteSolver = (params: {
+    terminals: Array<{
+        x: number;
+        y: number;
+        facing_direction?: "up" | "down" | "left" | "right";
+    }>;
+    obstacles: Array<{
+        cx: number;
+        cy: number;
+        w: number;
+        h: number;
+    }>;
+}) => Promise<Array<{
+    from: {
+        x: number;
+        y: number;
+    };
+    to: {
+        x: number;
+        y: number;
+    };
+}>>;
+
+export { RouteSolver };

package/dist/lib/types/source-component.d.ts

@@ -0,0 +1,44 @@
+import { NumberWithUnit } from './util.js';
+
+interface SourceComponentBase {
+    type: "source_component";
+    /** The functional type of this component, e.g. resistor, capacitor etc. */
+    ftype?: string;
+    source_component_id: string;
+    name: string;
+}
+interface SimpleResistor extends SourceComponentBase {
+    ftype: "simple_resistor";
+    resistance: NumberWithUnit<"ohm">;
+}
+interface SimpleCapacitor extends SourceComponentBase {
+    ftype: "simple_capacitor";
+    capacitance: NumberWithUnit<"farad">;
+}
+interface SimpleInductor extends SourceComponentBase {
+    ftype: "simple_inductor";
+    inductance: NumberWithUnit<"henry">;
+}
+interface SimpleDiode extends SourceComponentBase {
+    ftype: "simple_diode";
+}
+declare type LightEmittingDiode = SimpleDiode & {
+    ftype: "led";
+};
+interface SimpleBug extends SourceComponentBase {
+    ftype: "simple_bug";
+}
+interface SimplePowerSource extends SourceComponentBase {
+    ftype: "simple_power_source";
+    voltage: NumberWithUnit<"volt">;
+}
+interface SimpleGround extends SourceComponentBase {
+    ftype: "simple_ground";
+}
+declare type AnySourceComponent = SimpleResistor | SimpleCapacitor | SimpleBug | SimpleInductor | SimplePowerSource | SimpleGround | SimpleDiode | LightEmittingDiode;
+declare type SourceComponentFType = AnySourceComponent["ftype"];
+declare type SourceComponent<T extends SourceComponentFType = SourceComponentFType> = Extract<AnySourceComponent, {
+    ftype: T;
+}>;
+
+export { AnySourceComponent, LightEmittingDiode, SimpleBug, SimpleCapacitor, SimpleDiode, SimpleGround, SimpleInductor, SimplePowerSource, SimpleResistor, SourceComponent, SourceComponentBase, SourceComponentFType };

package/dist/lib/types/util.d.ts

@@ -0,0 +1,14 @@
+declare type SIPrefix = "femto" | "f" | "u" | "micro" | "c" | "centi" | "m" | "milli" | "k" | "kilo" | "M" | "mega";
+declare type UnitAbbreviations = {
+    farad: "F";
+    ohm: "Ω";
+    henry: "H";
+    meter: "m";
+    volt: "V";
+};
+declare type Unit = "ohm" | "farad" | "henry" | "meter" | "volt";
+declare type UnitOrAbbreviation = UnitAbbreviations[Unit] | Unit;
+declare type NumberWithAnyUnit = `${number}${UnitOrAbbreviation}` | `${number} ${UnitOrAbbreviation}` | `${number}${SIPrefix}${UnitOrAbbreviation}` | `${number} ${SIPrefix}${UnitOrAbbreviation}`;
+declare type NumberWithUnit<T extends Unit> = `${number}${T | UnitAbbreviations[T]}` | `${number} ${T | UnitAbbreviations[T]}` | `${number}${SIPrefix}${T | UnitAbbreviations[T]}` | `${number} ${SIPrefix}${T | UnitAbbreviations[T]}`;
+
+export { NumberWithAnyUnit, NumberWithUnit, SIPrefix, Unit, UnitAbbreviations, UnitOrAbbreviation };

package/dist/lib/utils/direction-to-vec.d.ts

@@ -0,0 +1,13 @@
+declare const directionToVec: (direction: "up" | "down" | "left" | "right") => {
+    x: number;
+    y: number;
+};
+declare const vecToDirection: ({ x, y }: {
+    x: number;
+    y: number;
+}) => "left" | "right" | "up" | "down";
+declare const rotateClockwise: (direction: "up" | "down" | "left" | "right") => "left" | "right" | "up" | "down";
+declare const rotateCounterClockwise: (direction: "up" | "down" | "left" | "right") => "left" | "right" | "up" | "down";
+declare const rotateDirection: (direction: "up" | "down" | "left" | "right", num90DegreeClockwiseTurns: number) => "left" | "right" | "up" | "down";
+
+export { directionToVec, rotateClockwise, rotateCounterClockwise, rotateDirection, vecToDirection };

package/dist/lib/utils/get-svg-path-bounds.d.ts

@@ -0,0 +1,10 @@
+declare function getSVGPathBounds(ds: string[] | string): {
+    minX: number;
+    maxX: number;
+    minY: number;
+    maxY: number;
+    width: number;
+    height: number;
+};
+
+export { getSVGPathBounds as default, getSVGPathBounds };

package/dist/lib/utils/point-math.d.ts

@@ -0,0 +1,20 @@
+declare type Point = {
+    x: number;
+    y: number;
+};
+declare function sub(p1: Point, p2: Point): {
+    x: number;
+    y: number;
+};
+declare function mult(p1: Point, p2: Point): {
+    x: number;
+    y: number;
+};
+declare function mag(p1: Point, p2: Point): number;
+declare function componentSum(p1: Point): number;
+declare function norm(p1: Point): {
+    x: number;
+    y: number;
+};
+
+export { Point, componentSum, mag, mult, norm, sub };

package/dist/pages/_app.d.ts

@@ -0,0 +1,5 @@
+declare const App: ({ Component }: {
+    Component: any;
+}) => JSX.Element;
+
+export { App, App as default };