@modular-circuit/perc 0.0.59 → 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,476 @@
+import * as _modular_circuit_electronics_model from '@modular-circuit/electronics-model';
+import { VECTOR2, BOX2, ELECTRICAL_NODE, ELECTRICAL_PINTYPE, ConnectionSubgraph, ConnectionNodeMap, GS_SCH_SHEET_PATH, ConnectionGraph, CG_SHEET, NL_PowerSymbol, PowerShape, PowerSymbolPort, Connection, ConnectionNode } from '@modular-circuit/electronics-model';
+import { SCH_ITEM, ModuleResolver, ModuleCircuit, IR_Graph } from '@modular-circuit/ir';
+import { PowerBase } from '@modular-circuit/ir/build/graph/pwr_base';
+import { CC_Visitor } from '@modular-circuit/utils';
+
+declare enum SEVERITY {
+    RPT_SEVERITY_UNDEFINED = 1,
+    RPT_SEVERITY_INFO = 2,
+    RPT_SEVERITY_EXCLUSION = 4,
+    RPT_SEVERITY_ACTION = 8,
+    RPT_SEVERITY_WARNING = 16,
+    RPT_SEVERITY_ERROR = 32,
+    RPT_SEVERITY_IGNORE = 64,
+    RPT_SEVERITY_DEBUG = 128
+}
+
+declare enum MakerType {
+    MARKER_UNSPEC = 0,
+    MARKER_ERC = 1,
+    MARKER_DRC = 2,
+    MARKER_DRAWING_SHEET = 3,
+    MARKER_RATSNEST = 4,
+    MARKER_PARITY = 5,
+    MARKER_SIMUL = 6
+}
+
+/**
+ * Marker are mainly used to show a DRC or ERC error or warning
+ */
+interface MarkerBase {
+    uuid: string;
+    /**
+     * @return the position of this marker in internal units.
+     */
+    pos: VECTOR2;
+    /**
+     * The type of marker (useful to filter markers)
+     */
+    maker_type: MakerType;
+    /**
+     * User has excluded this specific error
+     */
+    excluded: boolean;
+    /**
+     * User-supplied comment (generally for exclusions)
+     */
+    comment: string;
+    severity: SEVERITY;
+    /**
+     * The ID of the RC item that generated this marker
+     */
+    rc_item_id: string;
+    /**
+     * Return the orthogonal, bounding box of this object for display purposes.
+     */
+    bounding_box: BOX2;
+}
+
+interface SCH_MARKER extends MarkerBase, SCH_ITEM {
+}
+
+interface ERC_REPORT {
+    markers: SCH_MARKER[];
+    erc_errors: SCH_ERC_ITEM[];
+}
+interface ERC_REPORTER_CONTEXT {
+    pin_name_table: Record<string, string>;
+    pin_module_name_table: Record<string, string>;
+}
+declare function fmt_erc_item_description(id: string, ctx: ERC_REPORTER_CONTEXT): string;
+declare function get_erc_severity(code: string, settings?: {
+    erc_setting?: Record<ERCE_T, SEVERITY>;
+    pp_erc_setting?: Record<PP_ERROR, SEVERITY>;
+}): SEVERITY;
+
+declare const ERCE_UNANNOTATED: (id: string) => {
+    error_code: ERCE_T;
+    error_message: string;
+    eda_item_ids: string[];
+};
+declare const ERCE_PIN_TO_PIN_ERROR: (a: ELECTRICAL_NODE, b: ELECTRICAL_NODE) => {
+    error_code: ERCE_T;
+    error_message: string;
+    eda_item_ids: string[];
+};
+declare const ERCE_PIN_NOT_CONNECTED: (id: string) => {
+    error_code: ERCE_T;
+    error_message: string;
+    eda_item_ids: string[];
+};
+declare const ERCE_DRIVER_CONFLICT: (eda_item_ids: string[], primaryName: string, secondaryName: string) => {
+    error_code: PP_ERROR;
+    error_message: string;
+    eda_item_ids: string[];
+};
+declare const PP_INAPPROPRIATE_FUNC: (eda_item_ids: string[]) => {
+    error_code: PP_ERROR;
+    error_message: string;
+    eda_item_ids: string[];
+};
+declare const PP_NOT_DRIVEN: (eda_item_ids: string[]) => {
+    error_code: PP_ERROR;
+    error_message: string;
+    eda_item_ids: string[];
+};
+declare const PP_DUPLICATED_SOURCES: (eda_item_ids: string[]) => {
+    error_code: PP_ERROR;
+    error_message: string;
+    eda_item_ids: string[];
+};
+declare const PP_INSUFFICIENT_DRIVER: (eda_item_ids: string[], desc?: string) => {
+    error_code: PP_ERROR;
+    error_message: string;
+    eda_item_ids: string[];
+};
+declare const PP_OVER_DRIVEN: (eda_item_ids: string[], desc?: string) => {
+    error_code: PP_ERROR;
+    error_message: string;
+    eda_item_ids: string[];
+};
+declare const PP_IMPEDANCE_SIGNAL_INTEGRITY: (eda_item_ids: string[]) => {
+    error_code: PP_ERROR;
+    error_message: string;
+    eda_item_ids: string[];
+};
+declare const PP_INCOMPATIBLE_VOLTAGE_LEVELS: (source: string) => {
+    error_code: PP_ERROR;
+    error_message: string;
+    eda_item_ids: string[];
+};
+declare const PP_SIGNAL_LEVELS_NOT_CONTAINED_WITHIN_VOLTAGE: (source: string) => {
+    error_code: PP_ERROR;
+    error_message: string;
+    eda_item_ids: string[];
+};
+declare const PP_INCOMPATIBLE_SIGNAL_LEVELS: (source: string) => {
+    error_code: PP_ERROR;
+    error_message: string;
+    eda_item_ids: string[];
+};
+declare const PP_OVERCURRENT: (source: string) => {
+    error_code: PP_ERROR;
+    error_message: string;
+    eda_item_ids: string[];
+};
+declare const PP_INCOMPATIBLE_DIGITAL_THRESHOLDS: (eda_item_ids: string[]) => {
+    error_code: PP_ERROR;
+    error_message: string;
+    eda_item_ids: string[];
+};
+declare const PP_REQUIRES_CONNECTED_SOURCE_OR_BIDIR: (eda_item_ids: string[]) => {
+    error_code: PP_ERROR;
+    error_message: string;
+    eda_item_ids: string[];
+};
+declare const PP_ILLEGAL_CONNECTION: (eda_item_ids: string[], detail: string) => {
+    error_code: PP_ERROR;
+    error_message: string;
+    eda_item_ids: string[];
+};
+
+/**Token from KiCAD
+ * https://gitlab.com/kicad/code/kicad/-/blob/master/eeschema/erc/erc_settings.h
+ */
+declare enum ERCE_T {
+    ERCE_DUPLICATE_SHEET_NAME = "duplicate_sheet_names",
+    ERCE_ENDPOINT_OFF_GRID = "endpoint_off_grid",
+    ERCE_PIN_NOT_CONNECTED = "pin_not_connected",
+    ERCE_PIN_NOT_DRIVEN = "pin_not_driven",
+    ERCE_POWERPIN_NOT_DRIVEN = "power_pin_not_driven",
+    ERCE_HIERACHICAL_LABEL = "hier_label_mismatch",
+    ERCE_NOCONNECT_CONNECTED = "no_connect_connected",
+    ERCE_NOCONNECT_NOT_CONNECTED = "no_connect_dangling",
+    ERCE_LABEL_NOT_CONNECTED = "label_dangling",
+    ERCE_SIMILAR_LABELS = "similar_labels",
+    ERCE_SIMILAR_POWER = "similar_power",
+    ERCE_SIMILAR_LABEL_AND_POWER = "similar_label_and_power",
+    ERCE_SINGLE_GLOBAL_LABEL = "single_global_label",
+    ERCE_SAME_LOCAL_GLOBAL_LABEL = "same_local_global_label",
+    ERCE_DIFFERENT_UNIT_FP = "different_unit_footprint",
+    ERCE_MISSING_POWER_INPUT_PIN = "missing_power_input_pin",
+    ERCE_MISSING_INPUT_PIN = "missing_input_pin",
+    ERCE_MISSING_BIDI_PIN = "missing_bidi_pin",
+    ERCE_MISSING_UNIT = "missing_unit",
+    ERCE_DIFFERENT_UNIT_NET = "different_unit_net",
+    ERCE_BUS_ALIAS_CONFLICT = "bus_definition_conflict",
+    ERCE_DRIVER_CONFLICT = "multiple_net_names",
+    ERCE_BUS_ENTRY_CONFLICT = "net_not_bus_member",
+    ERCE_BUS_TO_BUS_CONFLICT = "bus_to_bus_conflict",
+    ERCE_BUS_TO_NET_CONFLICT = "bus_to_net_conflict",
+    ERCE_GLOBLABEL = "global_label_dangling",
+    ERCE_UNRESOLVED_VARIABLE = "unresolved_variable",
+    ERCE_UNDEFINED_NETCLASS = "undefined_netclass",
+    ERCE_SIMULATION_MODEL = "simulation_model_issue",
+    ERCE_WIRE_DANGLING = "wire_dangling",
+    ERCE_LIB_SYMBOL_ISSUES = "lib_symbol_issues",
+    ERCE_LIB_SYMBOL_MISMATCH = "lib_symbol_mismatch",
+    ERCE_FOOTPRINT_LINK_ISSUES = "footprint_link_issues",
+    ERCE_FOOTPRINT_FILTERS = "footprint_filter",
+    ERCE_UNANNOTATED = "unannotated",
+    ERCE_EXTRA_UNITS = "extra_units",
+    ERCE_DIFFERENT_UNIT_VALUE = "unit_value_mismatch",
+    ERCE_DUPLICATE_REFERENCE = "duplicate_reference",
+    ERCE_BUS_ENTRY_NEEDED = "bus_entry_needed",
+    ERCE_FOUR_WAY_JUNCTION = "four_way_junction",
+    ERCE_LABEL_MULTIPLE_WIRES = "label_multiple_wires",
+    ERCE_UNCONNECTED_WIRE_ENDPOINT = "unconnected_wire_endpoint",
+    ERCE_LAST = "unconnected_wire_endpoint",
+    ERCE_DUPLICATE_PIN_ERROR = "ERCE_DUPLICATE_PIN_ERROR",
+    ERCE_PIN_TO_PIN_WARNING = "ERCE_PIN_TO_PIN_WARNING",
+    ERCE_PIN_TO_PIN_ERROR = "ERCE_PIN_TO_PIN_ERROR",
+    ERCE_ANNOTATION_ACTION = "ERCE_ANNOTATION_ACTION",
+    ERCE_GENERIC_WARNING = "ERCE_GENERIC_WARNING",
+    ERCE_GENERIC_ERROR = "ERCE_GENERIC_ERROR"
+}
+
+declare enum PIN_ERROR {
+    OK = 0,
+    WARNING = 1,
+    PP_ERROR = 2,
+    UNCONNECTED = 3
+}
+
+declare class ERC_SETTING {
+    private pin_map;
+    private rule_severities;
+    constructor({ pin_map, rule_severities, }: {
+        pin_map: PIN_ERROR[][];
+        rule_severities: Record<ERCE_T, SEVERITY>;
+    });
+    IsTestEnabled(code: ERCE_T): boolean;
+    GetPinMapValue(aFirstType: ELECTRICAL_PINTYPE, aSecondType: ELECTRICAL_PINTYPE): PIN_ERROR;
+    SetPinMapValue(aFirstType: ELECTRICAL_PINTYPE, aSecondType: ELECTRICAL_PINTYPE, aValue: PIN_ERROR): void;
+    GetSeverity(code: ERCE_T): SEVERITY;
+    SetSeverity(code: ERCE_T, severity: SEVERITY): void;
+    toJSON(): {
+        pin_map: PIN_ERROR[][];
+        rule_severities: Record<ERCE_T, SEVERITY>;
+        erc_exclusions: never[];
+        meta: {
+            version: number;
+        };
+    };
+}
+declare const DEFAULT_PIN_MAP: PIN_ERROR[][];
+declare const DEFAULT_SEVERITY: Record<ERCE_T, SEVERITY>;
+declare const DEFAULT_ERC_SETTING: ERC_SETTING;
+
+interface CG_Visitor {
+    visit_cc(cc: ConnectionSubgraph): void;
+}
+
+declare class PIN_COMPATIBILITY_MATRIX_TESTER implements CG_Visitor {
+    private readonly ctx;
+    constructor(ctx: PIN_TO_PIN_TEST_CONTEXT);
+    visit_cc(cc: ConnectionSubgraph): void;
+}
+
+interface PIN_TO_PIN_TEST_CONTEXT {
+    report: ERC_REPORT;
+    erc_setting: ERC_SETTING;
+}
+
+type ADT_AdjacencyList = Set<string>;
+type ADT_Graph = Record<string, ADT_AdjacencyList>;
+
+interface GRAPH_CONVERTER {
+    convert_to_graph(design: unknown): true | Error[];
+    get_graph(): ADT_Graph;
+    get_connection_node_map(): ConnectionNodeMap;
+}
+
+interface CONNECTION_GRAPH_BUILDER_CTX {
+    module_resolver: ModuleResolver;
+    dependencies: Record<string, string>;
+    schematics: Record<string, unknown>;
+}
+
+/**
+ * PolymorphicBlocks blocks error codes start here.
+ *
+ * See https://github.com/BerkeleyHCI/PolymorphicBlocks/blob/master/compiler/src/main/scala/edg/compiler/CompilerError.scala
+ */
+
+declare enum PP_ERROR {
+    UN_COMPILED_BLOCK = "un_compiled_block",
+    UN_COMPILED_LINK = "un_compiled_link",
+    UN_COMPILED_LINK_ARRAY = "un_compiled_link_array",
+    UN_COMPILED_PARAMETER = "un_compiled_parameter",
+    UN_COMPILED_INTERNAL_ELEMENT = "un_compiled_internal_element",
+    UN_COMPILED_LIBRARY_ELEMENT = "un_compiled_library_element",
+    UNDEFINED_PORT_ARRAY = "undefined_port_array",
+    LIBRARY_ERROR = "library_error",
+    GENERATOR_ERROR = "generator_error",
+    REFINEMENT_SUBCLASS_ERROR = "refinement_subclass_error",
+    OVER_ASSIGN = "over_assign",
+    BAD_REFERENCE = "bad_reference",
+    ABSTRACT_BLOCK = "abstract_block",
+    FAILED_ASSERTION = "failed_assertion",
+    UN_EVALUATED_ASSERTION = "un_evaluated_assertion",
+    INCONSISTENT_LINK_ARRAY_ELEMENTS = "inconsistent_link_array_elements",
+    PP_UNANNOTATED = "pp_unannotated",
+    PP_UNKNOWN_PORT_TYPE = "pp_unknown_port_type",
+    INAPPROPRIATE_FUNC = "Functionally inappropriate link",
+    NOT_DRIVEN = "pp_not_driven",
+    DUPLICATED_PWR_SOURCES = "duplicated_pwr_sources",
+    INSUFFICIENT_DRIVER = "Insufficient_driver",
+    OVER_DRIVEN = "over_driven",
+    IMPEDANCE_SIGNAL_INTEGRITY = "impedance_signal_integrity",
+    INCOMPATIBLE_VOLTAGE_LEVELS = "incompatible_voltage_levels",
+    SIGNAL_LEVELS_NOT_CONTAINED_WITHIN_VOLTAGE = "signal_levels_not_contained_within_voltage",
+    INCOMPATIBLE_SIGNAL_LEVELS = "incompatible_signal_levels",
+    OVERCURRENT = "overcurrent",
+    INCOMPATIBLE_DIGITAL_THRESHOLDS = "incompatible_digital_thresholds",
+    REQUIRES_CONNECTED_SOURCE_OR_BIDIR = "requires_connected_source_or_bidir",
+    ILLEGAL_CONNECTION = "Illegal_connection"
+}
+declare const DEFAULT_PP_ERROR_SEVERITY: Record<PP_ERROR, SEVERITY>;
+
+interface ParameterPropagationTestContext {
+    report: ERC_REPORT;
+}
+declare class ParameterPropagationTester implements CG_Visitor {
+    private readonly ctx;
+    constructor(ctx: ParameterPropagationTestContext);
+    private link_map;
+    private port_id;
+    private has_passive_port;
+    private run_test;
+    visit_cc(cc: ConnectionSubgraph): void;
+}
+
+declare const DrivingPinTypes: Set<ELECTRICAL_PINTYPE>;
+declare const PowerDrivingPinTypes: Set<ELECTRICAL_PINTYPE>;
+declare const DrivenPinTypes: Set<ELECTRICAL_PINTYPE>;
+
+declare class NetlistTester implements CG_Visitor {
+    private readonly ctx;
+    constructor(ctx: PIN_TO_PIN_TEST_CONTEXT);
+    visit_cc(cc: ConnectionSubgraph): void;
+    private ercCheckMultipleDrivers;
+}
+
+/**
+ * A holder for a rule check item, DRC in Pcbnew or ERC in Eeschema.
+ *
+ * RC_ITEMs can have zero, one, or two related EDA_ITEMs.
+ */
+interface RC_ITEM {
+    /**
+     * The UUIDs of the eda items that are related to this item.
+     */
+    eda_item_ids: string[];
+    /**
+     *  The error code's numeric value
+     */
+    error_code: ERCE_T | PP_ERROR;
+    /**
+     * A message describing the details of this specific error
+     */
+    error_message: string;
+    /**
+     * The string describing the type of error
+     */
+    error_title?: string;
+    /**
+     * The key used to describe this type of error in settings
+     */
+    setting_key?: string;
+    /**
+     * The id of the marker this item belongs to, if any
+     */
+    parent_id?: string;
+}
+
+interface ERC_ITEM extends RC_ITEM {
+}
+
+interface SCH_ERC_ITEM extends ERC_ITEM {
+    /**
+     * Determines whether the ERC item is bound to a specific sheet, or is common across multiple
+     * sheets (e.g. whether the error is internal to a hierarchical sheet, or is due to an enclosing
+     * context interacting with the hierarchical sheet)
+     * @return true if ERC applies to a specific sheet, otherwise false
+     */
+    sheet_specific?: boolean;
+    /**
+     * Gets the EM_SCH_SHEET_PATH this ERC item is bound to. Throws std::bad_optional_access if there
+     * is no specific sheet path binding
+     * @return the EM_SCH_SHEET_PATH containing the ERC violation
+     */
+    sheet_specific_path?: GS_SCH_SHEET_PATH;
+    /**
+     * Gets the EM_SCH_SHEET_PATH of the main item causing this ERC violation
+     * @return EM_SCH_SHEET_PATH containing the main item
+     */
+    main_item_sheet_path?: GS_SCH_SHEET_PATH;
+    /**
+     * Gets the EM_SCH_SHEET_PATH of the auxiliary item causing this ERC violation
+     * @return EM_SCH_SHEET_PATH containing the auxiliary item
+     */
+    aux_item_sheet_path?: GS_SCH_SHEET_PATH;
+}
+
+interface ERC_CONTEXT extends ERC_REPORTER_CONTEXT {
+    erc_setting: ERC_SETTING;
+    pp_erc_setting: Record<PP_ERROR, SEVERITY>;
+    connection_graph: ConnectionGraph;
+}
+declare class ERC_TESTER {
+    private ctx;
+    constructor(ctx: ERC_CONTEXT);
+    run_test(): {
+        connection_graph: ConnectionGraph;
+        markers: SCH_MARKER[];
+        erc_errors: SCH_ERC_ITEM[];
+    };
+}
+
+interface CG_SCHEMATIC {
+    uuid: string;
+    sheets: CG_SHEET[];
+    powers: NL_PowerSymbol[];
+}
+declare class IR_GRAPH_CONVERTER implements GRAPH_CONVERTER {
+    private readonly circuits;
+    private graph;
+    private connection_node_map;
+    private schematics;
+    private reporter_context;
+    get_report_context(): ERC_REPORTER_CONTEXT;
+    constructor(circuits: Record<string, ModuleCircuit>);
+    convert_to_graph(designs: Record<string, IR_Graph>): true | Error[];
+    add_node(id: string): void;
+    add_pwr(pwr: PowerBase, shape: PowerShape, sch_name: string, param: PowerSymbolPort): void;
+    add_connection(from: string, to: string): void;
+    do_add_connection(conn: Connection): void;
+    get_connection_node_map(): ConnectionNodeMap;
+    get_graph(): ADT_Graph;
+    get_schematics(): Record<string, CG_SCHEMATIC>;
+}
+
+declare class ConnectionGraphsBuilder implements CC_Visitor {
+    private readonly connection_node_map;
+    private net_count;
+    private connection_graph;
+    private item_graphs;
+    constructor(connection_node_map: ConnectionNodeMap);
+    end_visit_component(cc: string[]): void;
+    resolve_net_drive(nodes: ConnectionNode[], sub_graph: ConnectionSubgraph): void;
+    get_connection_graph(): ConnectionGraph;
+    get_item_graphs(): Record<string, ConnectionSubgraph>;
+}
+declare function build_connection_graph(ctx: CONNECTION_GRAPH_BUILDER_CTX): Promise<{
+    connection_graph: ConnectionGraph;
+    item_graphs: Record<string, ConnectionSubgraph>;
+    cg_schematics: Record<string, CG_SCHEMATIC>;
+    pin_name_table: Record<string, string>;
+    pin_module_name_table: Record<string, string>;
+}>;
+
+type ERC_INPUT = CONNECTION_GRAPH_BUILDER_CTX & ERC_CONTEXT;
+declare function graph_ecr(ctx: Omit<ERC_INPUT, 'schematics'> & {
+    schematics: Record<string, IR_Graph>;
+}): Promise<{
+    connection_graph: _modular_circuit_electronics_model.ConnectionGraph;
+    item_graphs: Record<string, _modular_circuit_electronics_model.ConnectionSubgraph>;
+    cg_schematics: Record<string, CG_SCHEMATIC>;
+    pin_name_table: Record<string, string>;
+    pin_module_name_table: Record<string, string>;
+    markers: SCH_MARKER[];
+    erc_errors: SCH_ERC_ITEM[];
+}>;
+
+export { type ADT_AdjacencyList, type ADT_Graph, type CG_SCHEMATIC, type CONNECTION_GRAPH_BUILDER_CTX, ConnectionGraphsBuilder, DEFAULT_ERC_SETTING, DEFAULT_PIN_MAP, DEFAULT_PP_ERROR_SEVERITY, DEFAULT_SEVERITY, DrivenPinTypes, DrivingPinTypes, ERCE_DRIVER_CONFLICT, ERCE_PIN_NOT_CONNECTED, ERCE_PIN_TO_PIN_ERROR, ERCE_T, ERCE_UNANNOTATED, type ERC_CONTEXT, type ERC_INPUT, type ERC_ITEM, type ERC_REPORT, type ERC_REPORTER_CONTEXT, ERC_SETTING, ERC_TESTER, type GRAPH_CONVERTER, IR_GRAPH_CONVERTER, MakerType, type MarkerBase, NetlistTester, PIN_COMPATIBILITY_MATRIX_TESTER, PIN_ERROR, type PIN_TO_PIN_TEST_CONTEXT, PP_DUPLICATED_SOURCES, PP_ERROR, PP_ILLEGAL_CONNECTION, PP_IMPEDANCE_SIGNAL_INTEGRITY, PP_INAPPROPRIATE_FUNC, PP_INCOMPATIBLE_DIGITAL_THRESHOLDS, PP_INCOMPATIBLE_SIGNAL_LEVELS, PP_INCOMPATIBLE_VOLTAGE_LEVELS, PP_INSUFFICIENT_DRIVER, PP_NOT_DRIVEN, PP_OVERCURRENT, PP_OVER_DRIVEN, PP_REQUIRES_CONNECTED_SOURCE_OR_BIDIR, PP_SIGNAL_LEVELS_NOT_CONTAINED_WITHIN_VOLTAGE, type ParameterPropagationTestContext, ParameterPropagationTester, PowerDrivingPinTypes, type RC_ITEM, type SCH_ERC_ITEM, type SCH_MARKER, SEVERITY, build_connection_graph, fmt_erc_item_description, get_erc_severity, graph_ecr };