@tscircuit/parts-engine 0.0.17 → 0.0.19

package/dist/index.d.ts

@@ -1,25 +1,32 @@
-import { PartsEngine } from '@tscircuit/props';
 import * as zod from 'zod';
+import { PartsEngine } from '@tscircuit/props';
 
-type PlatformFetch = typeof fetch;
+type PlatformFetch = (input: Parameters<typeof fetch>[0], init?: Parameters<typeof fetch>[1]) => ReturnType<typeof fetch>;
 type FetchPartCircuitJsonParams = {
     supplierPartNumber?: string;
     manufacturerPartNumber?: string;
     platformFetch?: PlatformFetch;
 };
-type CreateJlcPartsEngineOptions = {
+type EasyEdaProxyConfig = {
+    proxyEndpointUrl: string;
+    headers?: Record<string, string>;
+};
+type JlcPcbPartsEngineOptions = {
     platformFetch?: PlatformFetch;
+    easyEdaProxyConfig?: EasyEdaProxyConfig;
 };
 
-declare class JlcPartsEngine implements PartsEngine {
-    private readonly platformFetch;
-    constructor(options?: CreateJlcPartsEngineOptions);
+declare class JlcPcbPartsEngine implements PartsEngine {
+    private readonly defaultPlatformFetch;
+    private readonly easyEdaProxyConfig;
+    constructor({ platformFetch: defaultPlatformFetch, easyEdaProxyConfig, }?: JlcPcbPartsEngineOptions);
+    private getEasyEdaPlatformFetch;
     findPart({ sourceComponent, footprinterString, }: Parameters<PartsEngine["findPart"]>[0]): Promise<{
         jlcpcb: string[];
     } | {
         jlcpcb?: undefined;
     }>;
-    fetchPartCircuitJson({ supplierPartNumber, manufacturerPartNumber, platformFetch: callPlatformFetch, }: Parameters<NonNullable<PartsEngine["fetchPartCircuitJson"]>>[0]): Promise<({
+    fetchPartCircuitJson({ supplierPartNumber, manufacturerPartNumber, platformFetch: platformFetchOverride, }: Parameters<NonNullable<PartsEngine["fetchPartCircuitJson"]>>[0]): Promise<({
         type: "source_trace";
         source_trace_id: string;
         connected_source_port_ids: string[];
@@ -243,6 +250,7 @@ declare class JlcPartsEngine implements PartsEngine {
         display_name?: string | undefined;
         are_pins_interchangeable?: boolean | undefined;
         internally_connected_source_port_ids?: string[][] | undefined;
+        display_inductance?: string | undefined;
         max_current_rating?: number | undefined;
     } | {
         type: "source_component";
@@ -550,6 +558,14 @@ declare class JlcPartsEngine implements PartsEngine {
         warning_type: "source_pin_missing_trace_warning";
         source_pin_missing_trace_warning_id: string;
         subcircuit_id?: string | undefined;
+    } | {
+        message: string;
+        type: "source_missing_manufacturer_part_number_warning";
+        source_component_id: string;
+        warning_type: "source_missing_manufacturer_part_number_warning";
+        standard: string;
+        source_missing_manufacturer_part_number_warning_id: string;
+        subcircuit_id?: string | undefined;
     } | {
         message: string;
         type: "source_i2c_misconfigured_error";
@@ -695,6 +711,7 @@ declare class JlcPartsEngine implements PartsEngine {
         display_name?: string | undefined;
         are_pins_interchangeable?: boolean | undefined;
         internally_connected_source_port_ids?: string[][] | undefined;
+        display_inductance?: string | undefined;
         max_current_rating?: number | undefined;
     } | {
         type: "source_component";
@@ -896,6 +913,14 @@ declare class JlcPartsEngine implements PartsEngine {
         warning_type: "source_pin_missing_trace_warning";
         source_pin_missing_trace_warning_id: string;
         subcircuit_id?: string | undefined;
+    } | {
+        message: string;
+        type: "source_missing_manufacturer_part_number_warning";
+        source_component_id: string;
+        warning_type: "source_missing_manufacturer_part_number_warning";
+        standard: string;
+        source_missing_manufacturer_part_number_warning_id: string;
+        subcircuit_id?: string | undefined;
     } | {
         message: string;
         type: "source_no_power_pin_defined_warning";
@@ -983,6 +1008,7 @@ declare class JlcPartsEngine implements PartsEngine {
             x: number;
             y: number;
         } | undefined;
+        insertion_direction?: "from_above" | "from_left" | "from_right" | "from_front" | "from_back" | undefined;
         metadata?: {
             kicad_footprint?: {
                 layer?: string | undefined;
@@ -1230,8 +1256,8 @@ declare class JlcPartsEngine implements PartsEngine {
         type: "pcb_manual_edit_conflict_warning";
         pcb_component_id: string;
         source_component_id: string;
-        pcb_manual_edit_conflict_warning_id: string;
         warning_type: "pcb_manual_edit_conflict_warning";
+        pcb_manual_edit_conflict_warning_id: string;
         subcircuit_id?: string | undefined;
         pcb_group_id?: string | undefined;
     } | {
@@ -1245,6 +1271,19 @@ declare class JlcPartsEngine implements PartsEngine {
         source_component_id?: string | undefined;
         subcircuit_id?: string | undefined;
         pcb_board_id?: string | undefined;
+    } | {
+        message: string;
+        type: "supplier_footprint_mismatch_warning";
+        source_component_id: string;
+        warning_type: "supplier_footprint_mismatch_warning";
+        supplier_footprint_mismatch_warning_id: string;
+        footprint_copper_intersection_over_union: number;
+        pcb_component_id?: string | undefined;
+        subcircuit_id?: string | undefined;
+        pcb_group_id?: string | undefined;
+        supplier_name?: "jlcpcb" | "macrofab" | "pcbway" | "digikey" | "mouser" | "lcsc" | undefined;
+        supplier_part_number?: string | undefined;
+        supplier_footprint_url?: string | undefined;
     } | {
         x: number;
         y: number;
@@ -1467,6 +1506,20 @@ declare class JlcPartsEngine implements PartsEngine {
         should_round_corners?: boolean | undefined;
         trace_length?: number | undefined;
         highlight_color?: string | undefined;
+    } | {
+        message: string;
+        type: "pcb_trace_warning";
+        source_trace_id: string;
+        pcb_trace_id: string;
+        pcb_trace_warning_id: string;
+        warning_type: "pcb_trace_warning";
+        pcb_component_ids: string[];
+        pcb_port_ids: string[];
+        center?: {
+            x: number;
+            y: number;
+        } | undefined;
+        subcircuit_id?: string | undefined;
     } | {
         x: number;
         y: number;
@@ -1673,6 +1726,14 @@ declare class JlcPartsEngine implements PartsEngine {
         material: "fr4" | "fr1";
         width?: number | undefined;
         height?: number | undefined;
+        min_trace_width?: number | undefined;
+        min_board_edge_clearance?: number | undefined;
+        min_via_hole_edge_to_via_hole_edge_clearance?: number | undefined;
+        min_plated_hole_drill_edge_to_drill_edge_clearance?: number | undefined;
+        min_trace_to_pad_edge_clearance?: number | undefined;
+        min_pad_edge_to_pad_edge_clearance?: number | undefined;
+        min_via_hole_diameter?: number | undefined;
+        min_via_pad_diameter?: number | undefined;
         shape?: "rect" | "polygon" | undefined;
         display_offset_x?: string | undefined;
         display_offset_y?: string | undefined;
@@ -1888,10 +1949,10 @@ declare class JlcPartsEngine implements PartsEngine {
         type: "pcb_trace_error";
         source_trace_id: string;
         pcb_trace_id: string;
-        error_type: "pcb_trace_error";
-        pcb_trace_error_id: string;
         pcb_component_ids: string[];
         pcb_port_ids: string[];
+        error_type: "pcb_trace_error";
+        pcb_trace_error_id: string;
         center?: {
             x: number;
             y: number;
@@ -1902,9 +1963,9 @@ declare class JlcPartsEngine implements PartsEngine {
         message: string;
         type: "pcb_trace_missing_error";
         source_trace_id: string;
-        error_type: "pcb_trace_missing_error";
         pcb_component_ids: string[];
         pcb_port_ids: string[];
+        error_type: "pcb_trace_missing_error";
         pcb_trace_missing_error_id: string;
         center?: {
             x: number;
@@ -1931,17 +1992,17 @@ declare class JlcPartsEngine implements PartsEngine {
     } | {
         message: string;
         type: "pcb_port_not_matched_error";
-        error_type: "pcb_port_not_matched_error";
         pcb_component_ids: string[];
+        error_type: "pcb_port_not_matched_error";
         pcb_error_id: string;
         subcircuit_id?: string | undefined;
         is_fatal?: boolean | undefined;
     } | {
         message: string;
         type: "pcb_port_not_connected_error";
-        error_type: "pcb_port_not_connected_error";
         pcb_component_ids: string[];
         pcb_port_ids: string[];
+        error_type: "pcb_port_not_connected_error";
         pcb_port_not_connected_error_id: string;
         subcircuit_id?: string | undefined;
         is_fatal?: boolean | undefined;
@@ -1959,6 +2020,50 @@ declare class JlcPartsEngine implements PartsEngine {
             x?: number | undefined;
             y?: number | undefined;
         } | undefined;
+    } | {
+        message: string;
+        type: "pcb_via_trace_clearance_error";
+        pcb_trace_id: string;
+        error_type: "pcb_via_trace_clearance_error";
+        pcb_via_id: string;
+        pcb_via_trace_clearance_error_id: string;
+        center?: {
+            x?: number | undefined;
+            y?: number | undefined;
+        } | undefined;
+        subcircuit_id?: string | undefined;
+        is_fatal?: boolean | undefined;
+        minimum_clearance?: number | undefined;
+        actual_clearance?: number | undefined;
+    } | {
+        message: string;
+        type: "pcb_pad_pad_clearance_error";
+        error_type: "pcb_pad_pad_clearance_error";
+        pcb_pad_pad_clearance_error_id: string;
+        pcb_pad_ids: string[];
+        center?: {
+            x?: number | undefined;
+            y?: number | undefined;
+        } | undefined;
+        subcircuit_id?: string | undefined;
+        is_fatal?: boolean | undefined;
+        minimum_clearance?: number | undefined;
+        actual_clearance?: number | undefined;
+    } | {
+        message: string;
+        type: "pcb_pad_trace_clearance_error";
+        pcb_trace_id: string;
+        error_type: "pcb_pad_trace_clearance_error";
+        pcb_pad_trace_clearance_error_id: string;
+        pcb_pad_id: string;
+        center?: {
+            x?: number | undefined;
+            y?: number | undefined;
+        } | undefined;
+        subcircuit_id?: string | undefined;
+        is_fatal?: boolean | undefined;
+        minimum_clearance?: number | undefined;
+        actual_clearance?: number | undefined;
     } | {
         type: "pcb_fabrication_note_path";
         layer: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6";
@@ -2036,6 +2141,7 @@ declare class JlcPartsEngine implements PartsEngine {
     } | {
         type: "pcb_note_text";
         font: "tscircuit2024";
+        layer: "top" | "bottom";
         anchor_position: {
             x: number;
             y: number;
@@ -2049,10 +2155,12 @@ declare class JlcPartsEngine implements PartsEngine {
         pcb_group_id?: string | undefined;
         text?: string | undefined;
         color?: string | undefined;
+        is_mirrored_from_top_view?: boolean | undefined;
     } | {
         type: "pcb_note_rect";
         width: number;
         height: number;
+        layer: "top" | "bottom";
         center: {
             x: number;
             y: number;
@@ -2071,6 +2179,7 @@ declare class JlcPartsEngine implements PartsEngine {
         color?: string | undefined;
     } | {
         type: "pcb_note_path";
+        layer: "top" | "bottom";
         route: {
             x: number;
             y: number;
@@ -2085,6 +2194,7 @@ declare class JlcPartsEngine implements PartsEngine {
         color?: string | undefined;
     } | {
         type: "pcb_note_line";
+        layer: "top" | "bottom";
         stroke_width: number;
         x1: number;
         y1: number;
@@ -2101,6 +2211,7 @@ declare class JlcPartsEngine implements PartsEngine {
     } | {
         type: "pcb_note_dimension";
         font: "tscircuit2024";
+        layer: "top" | "bottom";
         font_size: number;
         from: {
             x: number;
@@ -2144,8 +2255,8 @@ declare class JlcPartsEngine implements PartsEngine {
     } | {
         message: string;
         type: "pcb_courtyard_overlap_error";
-        error_type: "pcb_courtyard_overlap_error";
         pcb_component_ids: [string, string];
+        error_type: "pcb_courtyard_overlap_error";
         pcb_error_id: string;
         is_fatal?: boolean | undefined;
     } | {
@@ -4256,7 +4367,11 @@ declare class JlcPartsEngine implements PartsEngine {
 
 declare const cache: Map<string, any>;
 
-declare const createJlcPartsEngine: (options?: CreateJlcPartsEngineOptions) => PartsEngine;
-declare const jlcPartsEngine: PartsEngine;
+declare const getFetchWithEasyEdaProxy: ({ platformFetch: upstreamFetch, easyEdaProxyConfig, }: {
+    platformFetch: PlatformFetch;
+    easyEdaProxyConfig: EasyEdaProxyConfig;
+}) => PlatformFetch;
+
+declare const jlcPartsEngine: JlcPcbPartsEngine;
 
-export { type CreateJlcPartsEngineOptions, type FetchPartCircuitJsonParams, JlcPartsEngine, type PlatformFetch, cache, createJlcPartsEngine, jlcPartsEngine };
+export { type EasyEdaProxyConfig, type FetchPartCircuitJsonParams, JlcPcbPartsEngine, type JlcPcbPartsEngineOptions, type PlatformFetch, cache, getFetchWithEasyEdaProxy, jlcPartsEngine };

package/dist/index.js

@@ -10432,6 +10432,91 @@ var getJlcpcbPackageName = (footprint) => {
   return getJlcPackageFromFootprinterString(footprint);
 };
 
+// lib/jlc-parts-engine/getFetchWithEasyEdaProxy.ts
+var EASYEDA_API_ORIGIN = "https://easyeda.com";
+var METHODS_WITHOUT_BODY = /* @__PURE__ */ new Set(["GET", "HEAD"]);
+var getRequestUrl = (requestInput) => {
+  if (typeof requestInput === "string") return requestInput;
+  if (requestInput instanceof URL) return requestInput.toString();
+  return requestInput.url;
+};
+var createMergedTargetRequest = (requestInput, requestInit) => {
+  if (requestInput instanceof URL) {
+    return new Request(requestInput.toString(), requestInit);
+  }
+  if (typeof requestInput === "string") {
+    return new Request(requestInput, requestInit);
+  }
+  return new Request(requestInput, requestInit);
+};
+var isEasyEdaApiRequestUrl = (requestUrl) => requestUrl.startsWith(`${EASYEDA_API_ORIGIN}/api/`);
+var getFetchWithEasyEdaProxy = ({
+  platformFetch: upstreamFetch,
+  easyEdaProxyConfig
+}) => {
+  return async (requestInput, requestInit) => {
+    const targetRequestUrl = getRequestUrl(requestInput);
+    if (!isEasyEdaApiRequestUrl(targetRequestUrl)) {
+      return upstreamFetch(requestInput, requestInit);
+    }
+    const mergedTargetRequest = createMergedTargetRequest(
+      requestInput,
+      requestInit
+    );
+    const targetRequestHeaders = new Headers(mergedTargetRequest.headers);
+    const proxyRequestHeaders = new Headers(targetRequestHeaders);
+    proxyRequestHeaders.delete("origin");
+    proxyRequestHeaders.delete("authority");
+    proxyRequestHeaders.delete("host");
+    proxyRequestHeaders.delete("referer");
+    proxyRequestHeaders.delete("user-agent");
+    proxyRequestHeaders.delete("cookie");
+    proxyRequestHeaders.set("X-Target-Url", targetRequestUrl);
+    proxyRequestHeaders.set(
+      "X-Sender-Origin",
+      targetRequestHeaders.get("origin") ?? ""
+    );
+    proxyRequestHeaders.set(
+      "X-Sender-Host",
+      targetRequestHeaders.get("host") ?? EASYEDA_API_ORIGIN
+    );
+    proxyRequestHeaders.set(
+      "X-Sender-Referer",
+      targetRequestHeaders.get("referer") ?? ""
+    );
+    proxyRequestHeaders.set(
+      "X-Sender-User-Agent",
+      targetRequestHeaders.get("user-agent") ?? ""
+    );
+    proxyRequestHeaders.set(
+      "X-Sender-Cookie",
+      targetRequestHeaders.get("cookie") ?? ""
+    );
+    proxyRequestHeaders.set(
+      "authority",
+      targetRequestHeaders.get("authority") ?? targetRequestHeaders.get("host") ?? ""
+    );
+    proxyRequestHeaders.set(
+      "content-type",
+      targetRequestHeaders.get("content-type") ?? ""
+    );
+    for (const [name, value] of Object.entries(
+      easyEdaProxyConfig.headers ?? {}
+    )) {
+      proxyRequestHeaders.set(name, value);
+    }
+    const proxyRequestBody = METHODS_WITHOUT_BODY.has(
+      mergedTargetRequest.method
+    ) ? void 0 : await mergedTargetRequest.clone().arrayBuffer();
+    return upstreamFetch(easyEdaProxyConfig.proxyEndpointUrl, {
+      method: mergedTargetRequest.method,
+      headers: proxyRequestHeaders,
+      body: proxyRequestBody,
+      signal: requestInit?.signal
+    });
+  };
+};
+
 // lib/jlc-parts-engine/jlc-parts-cache.ts
 var cache = /* @__PURE__ */ new Map();
 var getJlcPartsCached = async (name, params) => {
@@ -10457,10 +10542,25 @@ var withBasicPartPreference = (parts) => {
 };
 
 // lib/jlc-parts-engine/JlcPartsEngine.ts
-var JlcPartsEngine = class {
-  platformFetch;
-  constructor(options = {}) {
-    this.platformFetch = options.platformFetch;
+var JlcPcbPartsEngine = class {
+  defaultPlatformFetch;
+  easyEdaProxyConfig;
+  constructor({
+    platformFetch: defaultPlatformFetch,
+    easyEdaProxyConfig
+  } = {}) {
+    this.defaultPlatformFetch = defaultPlatformFetch;
+    this.easyEdaProxyConfig = easyEdaProxyConfig;
+  }
+  getEasyEdaPlatformFetch(platformFetchOverride) {
+    const resolvedPlatformFetch = platformFetchOverride ?? this.defaultPlatformFetch ?? globalThis.fetch;
+    if (!this.easyEdaProxyConfig) {
+      return resolvedPlatformFetch;
+    }
+    return getFetchWithEasyEdaProxy({
+      platformFetch: resolvedPlatformFetch,
+      easyEdaProxyConfig: this.easyEdaProxyConfig
+    });
   }
   async findPart({
     sourceComponent,
@@ -10613,32 +10713,36 @@ var JlcPartsEngine = class {
   async fetchPartCircuitJson({
     supplierPartNumber,
     manufacturerPartNumber,
-    platformFetch: callPlatformFetch
+    platformFetch: platformFetchOverride
   }) {
-    const easyEdaFetch = callPlatformFetch ?? this.platformFetch ?? globalThis.fetch;
-    let resolvedPartNumber = supplierPartNumber;
-    if (!resolvedPartNumber && manufacturerPartNumber) {
+    const easyEdaPlatformFetch = this.getEasyEdaPlatformFetch(
+      platformFetchOverride
+    );
+    let resolvedSupplierPartNumber = supplierPartNumber;
+    if (!resolvedSupplierPartNumber && manufacturerPartNumber) {
       const { components } = await getJlcPartsCached("components", {
         search: manufacturerPartNumber
       });
-      resolvedPartNumber = components?.[0] ? `C${components[0].lcsc}` : void 0;
+      resolvedSupplierPartNumber = components?.[0] ? `C${components[0].lcsc}` : void 0;
     }
-    if (!resolvedPartNumber) return void 0;
-    const rawEasyEdaJson = await fetchEasyEDAComponent(resolvedPartNumber, {
-      fetch: easyEdaFetch
-    });
+    if (!resolvedSupplierPartNumber) return void 0;
+    const rawEasyEdaJson = await fetchEasyEDAComponent(
+      resolvedSupplierPartNumber,
+      {
+        fetch: easyEdaPlatformFetch
+      }
+    );
     const parsed = EasyEdaJsonSchema.parse(rawEasyEdaJson);
     return convertEasyEdaJsonToCircuitJson(parsed);
   }
 };
 
 // lib/jlc-parts-engine/index.ts
-var createJlcPartsEngine = (options = {}) => new JlcPartsEngine(options);
-var jlcPartsEngine = new JlcPartsEngine();
+var jlcPartsEngine = new JlcPcbPartsEngine();
 export {
-  JlcPartsEngine,
+  JlcPcbPartsEngine,
   cache,
-  createJlcPartsEngine,
+  getFetchWithEasyEdaProxy,
   jlcPartsEngine
 };
 //# sourceMappingURL=index.js.map