@intelligentelectron/universal-netlist 0.0.12

package/dist/service.d.ts

@@ -0,0 +1,129 @@
+/**
+ * Netlist Service
+ *
+ * Query methods for Cadence and Altium netlists using absolute paths.
+ * All methods take an absolute path to the design FILE as input.
+ */
+import { type ParsedNetlist, type ComponentDetails, type CircuitComponent, type AggregatedCircuitResult, type ErrorResult, type ComponentGroup, type ListComponentsResult, type ListNetsResult, type SearchComponentsResult, type SearchNetsResult, type QueryComponentResult, type CadenceInstall, type ExportNetlistResult } from "./types.js";
+/**
+ * Load netlist from an absolute design file path.
+ * Delegates to the appropriate handler based on file extension.
+ */
+export declare const loadNetlist: (designPath: string) => Promise<ParsedNetlist | ErrorResult>;
+declare const MPN_MISSING_NOTE = "MPN not found in exported netlist data. Tell user to update symbol properties in library, or to point you to the BOM";
+/**
+ * Group components by MPN for compact output.
+ */
+declare const groupComponentsByMpn: (entries: Array<[string, ComponentDetails[string]]>, includeDns: boolean) => ComponentGroup[];
+/**
+ * Aggregate circuit components by MPN for compact output.
+ */
+declare const aggregateCircuitByMpn: (components: CircuitComponent[]) => AggregatedCircuitResult["components_by_mpn"];
+/**
+ * List all designs in a directory.
+ *
+ * @param searchPath - Absolute path to search (defaults to CWD)
+ * @param pattern - Regex pattern to filter design names
+ */
+export declare const listDesigns: (searchPath?: string, pattern?: string) => Promise<Array<{
+    name: string;
+    path: string;
+    error?: string;
+}> | ErrorResult>;
+/**
+ * List components of a specific type in a design.
+ *
+ * @param design - Absolute path to design file
+ * @param type - Component type prefix (e.g., "U", "R", "C")
+ * @param includeDns - Include DNS (Do Not Stuff) components
+ */
+export declare const listComponents: (design: string, type: string, includeDns?: boolean) => Promise<ListComponentsResult | ErrorResult>;
+/**
+ * List all nets within a design.
+ *
+ * @param design - Absolute path to design file
+ */
+export declare const listNets: (design: string) => Promise<ListNetsResult | ErrorResult>;
+/**
+ * Search nets by regex pattern.
+ *
+ * @param pattern - Regex pattern
+ * @param design - Absolute path to design file
+ */
+export declare const searchNets: (pattern: string, design: string) => Promise<SearchNetsResult | ErrorResult>;
+/**
+ * Search components by refdes pattern.
+ *
+ * @param pattern - Regex pattern
+ * @param design - Absolute path to design file
+ * @param includeDns - Include DNS components
+ */
+export declare const searchComponentsByRefdes: (pattern: string, design: string, includeDns?: boolean) => Promise<SearchComponentsResult | ErrorResult>;
+/**
+ * Search components by MPN pattern.
+ *
+ * @param pattern - Regex pattern
+ * @param design - Absolute path to design file
+ * @param includeDns - Include DNS components
+ */
+export declare const searchComponentsByMpn: (pattern: string, design: string, includeDns?: boolean) => Promise<SearchComponentsResult | ErrorResult>;
+/**
+ * Search components by description pattern.
+ *
+ * @param pattern - Regex pattern
+ * @param design - Absolute path to design file
+ * @param includeDns - Include DNS components
+ */
+export declare const searchComponentsByDescription: (pattern: string, design: string, includeDns?: boolean) => Promise<SearchComponentsResult | ErrorResult>;
+/**
+ * Query component details by reference designator.
+ *
+ * @param design - Absolute path to design file
+ * @param refdes - Component reference designator
+ */
+export declare const queryComponent: (design: string, refdes: string) => Promise<QueryComponentResult | ErrorResult>;
+/**
+ * Query circuit starting from a net name.
+ *
+ * @param design - Absolute path to design file
+ * @param netName - Net name
+ * @param skipTypes - Component types to skip
+ * @param includeDns - Include DNS components
+ */
+export declare const queryXnetByNetName: (design: string, netName: string, skipTypes?: string[], includeDns?: boolean) => Promise<AggregatedCircuitResult | ErrorResult>;
+/**
+ * Query circuit starting from a component pin.
+ *
+ * @param design - Absolute path to design file
+ * @param pinSpec - Pin specification in "REFDES.PIN" format
+ * @param skipTypes - Component types to skip
+ * @param includeDns - Include DNS components
+ */
+export declare const queryXnetByPinName: (design: string, pinSpec: string, skipTypes?: string[], includeDns?: boolean) => Promise<AggregatedCircuitResult | ErrorResult>;
+/**
+ * Detect installed Cadence SPB versions from the standard installation directory.
+ *
+ * @param cadenceBase - Base Cadence installation directory (default: C:/Cadence)
+ * @returns Array of detected Cadence installations, sorted by version descending
+ */
+export declare const detectCadenceVersions: (cadenceBase?: string) => Promise<CadenceInstall[]>;
+/**
+ * Get the latest installed Cadence version.
+ *
+ * @returns The latest Cadence installation, or null if none found
+ */
+export declare const getLatestCadence: () => Promise<CadenceInstall | null>;
+/**
+ * Export Cadence schematic netlist to Allegro PCB format.
+ * Uses the pstswp utility from Cadence SPB installation.
+ *
+ * @param dsnPath - Absolute path to .DSN schematic file
+ * @returns Export result with output directory and generated files, or error
+ */
+export declare const exportCadenceNetlist: (dsnPath: string) => Promise<ExportNetlistResult | ErrorResult>;
+/**
+ * Internal exports for testing purposes only.
+ * @internal
+ */
+export { MPN_MISSING_NOTE, groupComponentsByMpn, aggregateCircuitByMpn };
+//# sourceMappingURL=service.d.ts.map

package/dist/service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AA4CH,OAAO,EAIL,KAAK,aAAa,EAClB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,uBAAuB,EAE5B,KAAK,WAAW,EAChB,KAAK,cAAc,EACnB,KAAK,oBAAoB,EACzB,KAAK,cAAc,EACnB,KAAK,sBAAsB,EAC3B,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EACzB,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACzB,MAAM,YAAY,CAAC;AA0BpB;;;GAGG;AACH,eAAO,MAAM,WAAW,GACtB,YAAY,MAAM,KACjB,OAAO,CAAC,aAAa,GAAG,WAAW,CAmBrC,CAAC;AAMF,QAAA,MAAM,gBAAgB,yHACkG,CAAC;AAEzH;;GAEG;AACH,QAAA,MAAM,oBAAoB,GACxB,SAAS,KAAK,CAAC,CAAC,MAAM,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,EAClD,YAAY,OAAO,KAClB,cAAc,EA4EhB,CAAC;AAEF;;GAEG;AACH,QAAA,MAAM,qBAAqB,GACzB,YAAY,gBAAgB,EAAE,KAC7B,uBAAuB,CAAC,mBAAmB,CA2J7C,CAAC;AAMF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GACtB,aAAa,MAAM,EACnB,gBAAc,KACb,OAAO,CACR,KAAK,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,GAAG,WAAW,CAmBpE,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,GACzB,QAAQ,MAAM,EACd,MAAM,MAAM,EACZ,oBAAkB,KACjB,OAAO,CAAC,oBAAoB,GAAG,WAAW,CAiC5C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,QAAQ,GACnB,QAAQ,MAAM,KACb,OAAO,CAAC,cAAc,GAAG,WAAW,CAQtC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,GACrB,SAAS,MAAM,EACf,QAAQ,MAAM,KACb,OAAO,CAAC,gBAAgB,GAAG,WAAW,CAyBxC,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB,GACnC,SAAS,MAAM,EACf,QAAQ,MAAM,EACd,oBAAkB,KACjB,OAAO,CAAC,sBAAsB,GAAG,WAAW,CA6B9C,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,GAChC,SAAS,MAAM,EACf,QAAQ,MAAM,EACd,oBAAkB,KACjB,OAAO,CAAC,sBAAsB,GAAG,WAAW,CA4C9C,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,6BAA6B,GACxC,SAAS,MAAM,EACf,QAAQ,MAAM,EACd,oBAAkB,KACjB,OAAO,CAAC,sBAAsB,GAAG,WAAW,CA8C9C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GACzB,QAAQ,MAAM,EACd,QAAQ,MAAM,KACb,OAAO,CAAC,oBAAoB,GAAG,WAAW,CA6C5C,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB,GAC7B,QAAQ,MAAM,EACd,SAAS,MAAM,EACf,YAAW,MAAM,EAAO,EACxB,oBAAkB,KACjB,OAAO,CAAC,uBAAuB,GAAG,WAAW,CA2C/C,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB,GAC7B,QAAQ,MAAM,EACd,SAAS,MAAM,EACf,YAAW,MAAM,EAAO,EACxB,oBAAkB,KACjB,OAAO,CAAC,uBAAuB,GAAG,WAAW,CAiF/C,CAAC;AAiBF;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,GAChC,oBAA0B,KACzB,OAAO,CAAC,cAAc,EAAE,CA4B1B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,QAAa,OAAO,CAAC,cAAc,GAAG,IAAI,CAGtE,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,GAC/B,SAAS,MAAM,KACd,OAAO,CAAC,mBAAmB,GAAG,WAAW,CA6D3C,CAAC;AAMF;;;GAGG;AACH,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,CAAC"}