circuit-json-to-step 0.0.3 → 0.0.5

package/dist/index.d.ts

@@ -13,6 +13,12 @@ interface CircuitJsonToStepOptions {
     includeComponents?: boolean;
     /** Include external model meshes from model_*_url fields (default: false). Only applicable when includeComponents is true. */
     includeExternalMeshes?: boolean;
+    /**
+     * Pre-loaded STEP file contents, keyed by URL/path.
+     * If a URL is found here, the content is used directly instead of fetching.
+     * Useful for tests that need to load local files.
+     */
+    fsMap?: Record<string, string>;
 }
 /**
  * Converts circuit JSON to STEP format, creating holes in a PCB board

package/dist/index.js

@@ -409,32 +409,26 @@ function rotateVector(vector, rotation) {
 }
 
 // lib/step-model-merger/read-step-file.ts
-import { promises as fs } from "fs";
-import path from "path";
-import { fileURLToPath } from "url";
 async function readStepFile(modelUrl) {
-  if (/^https?:\/\//i.test(modelUrl)) {
-    const globalFetch = globalThis.fetch;
-    if (!globalFetch) {
-      throw new Error("fetch is not available in this environment");
-    }
-    const res = await globalFetch(modelUrl);
-    if (!res.ok) {
-      throw new Error(`HTTP ${res.status} ${res.statusText}`);
-    }
-    return await res.text();
+  if (!/^https?:\/\//i.test(modelUrl)) {
+    throw new Error(
+      `Only HTTP(S) URLs are supported. For local files, read the file content and pass it directly. Received: ${modelUrl}`
+    );
+  }
+  const globalFetch = globalThis.fetch;
+  if (!globalFetch) {
+    throw new Error("fetch is not available in this environment");
   }
-  if (modelUrl.startsWith("file://")) {
-    const filePath = fileURLToPath(modelUrl);
-    return await fs.readFile(filePath, "utf8");
+  const res = await globalFetch(modelUrl);
+  if (!res.ok) {
+    throw new Error(`HTTP ${res.status} ${res.statusText}`);
   }
-  const resolvedPath = path.isAbsolute(modelUrl) ? modelUrl : path.resolve(process.cwd(), modelUrl);
-  return await fs.readFile(resolvedPath, "utf8");
+  return await res.text();
 }
 
 // lib/step-model-merger.ts
 async function mergeExternalStepModels(options) {
-  const { repo, circuitJson, boardThickness } = options;
+  const { repo, circuitJson, boardThickness, fsMap } = options;
   const cadComponents = circuitJson.filter(
     (item) => item?.type === "cad_component" && typeof item.model_step_url === "string"
   );
@@ -451,7 +445,7 @@ async function mergeExternalStepModels(options) {
     const componentId = component.cad_component_id ?? "";
     const stepUrl = component.model_step_url;
     try {
-      const stepText = await readStepFile(stepUrl);
+      const stepText = fsMap?.[stepUrl] ?? await readStepFile(stepUrl);
       if (!stepText.trim()) {
         throw new Error("STEP file is empty");
       }
@@ -1085,7 +1079,8 @@ async function circuitJsonToStep(circuitJson, options = {}) {
     const mergeResult = await mergeExternalStepModels({
       repo,
       circuitJson,
-      boardThickness
+      boardThickness,
+      fsMap: options.fsMap
     });
     handledComponentIds = mergeResult.handledComponentIds;
     handledPcbComponentIds = mergeResult.handledPcbComponentIds;

package/lib/index.ts

@@ -57,6 +57,12 @@ export interface CircuitJsonToStepOptions {
   includeComponents?: boolean
   /** Include external model meshes from model_*_url fields (default: false). Only applicable when includeComponents is true. */
   includeExternalMeshes?: boolean
+  /**
+   * Pre-loaded STEP file contents, keyed by URL/path.
+   * If a URL is found here, the content is used directly instead of fetching.
+   * Useful for tests that need to load local files.
+   */
+  fsMap?: Record<string, string>
 }
 
 /**
@@ -510,6 +516,7 @@ export async function circuitJsonToStep(
       repo,
       circuitJson,
       boardThickness,
+      fsMap: options.fsMap,
     })
     handledComponentIds = mergeResult.handledComponentIds
     handledPcbComponentIds = mergeResult.handledPcbComponentIds

package/lib/step-model-merger/read-step-file.ts

@@ -1,29 +1,23 @@
-import { promises as fs } from "node:fs"
-import path from "node:path"
-import { fileURLToPath } from "node:url"
-
+/**
+ * Fetches STEP file content from an HTTP(S) URL.
+ * For local files, the caller must read the file and pass the content directly.
+ */
 export async function readStepFile(modelUrl: string): Promise<string> {
-  if (/^https?:\/\//i.test(modelUrl)) {
-    const globalFetch = (globalThis as any).fetch as
-      | ((input: string, init?: unknown) => Promise<any>)
-      | undefined
-    if (!globalFetch) {
-      throw new Error("fetch is not available in this environment")
-    }
-    const res = await globalFetch(modelUrl)
-    if (!res.ok) {
-      throw new Error(`HTTP ${res.status} ${res.statusText}`)
-    }
-    return await res.text()
+  if (!/^https?:\/\//i.test(modelUrl)) {
+    throw new Error(
+      `Only HTTP(S) URLs are supported. For local files, read the file content and pass it directly. Received: ${modelUrl}`,
+    )
   }
 
-  if (modelUrl.startsWith("file://")) {
-    const filePath = fileURLToPath(modelUrl)
-    return await fs.readFile(filePath, "utf8")
+  const globalFetch = (globalThis as any).fetch as
+    | ((input: string, init?: unknown) => Promise<any>)
+    | undefined
+  if (!globalFetch) {
+    throw new Error("fetch is not available in this environment")
   }
-
-  const resolvedPath = path.isAbsolute(modelUrl)
-    ? modelUrl
-    : path.resolve(process.cwd(), modelUrl)
-  return await fs.readFile(resolvedPath, "utf8")
+  const res = await globalFetch(modelUrl)
+  if (!res.ok) {
+    throw new Error(`HTTP ${res.status} ${res.statusText}`)
+  }
+  return await res.text()
 }

package/lib/step-model-merger/types.ts

@@ -37,4 +37,10 @@ export interface MergeStepModelOptions {
   repo: Repository
   circuitJson: CircuitJson
   boardThickness: number
+  /**
+   * Pre-loaded STEP file contents, keyed by file path.
+   * If a path is found here, the content is used directly instead of reading from disk.
+   * Useful for browser environments where fs is not available.
+   */
+  fsMap?: Record<string, string>
 }

package/lib/step-model-merger.ts

@@ -33,7 +33,7 @@ export type {
 export async function mergeExternalStepModels(
   options: MergeStepModelOptions,
 ): Promise<MergeStepModelResult> {
-  const { repo, circuitJson, boardThickness } = options
+  const { repo, circuitJson, boardThickness, fsMap } = options
   const cadComponents = (circuitJson as CadComponent[]).filter(
     (item) =>
       item?.type === "cad_component" && typeof item.model_step_url === "string",
@@ -55,7 +55,7 @@ export async function mergeExternalStepModels(
     const stepUrl = component.model_step_url!
 
     try {
-      const stepText = await readStepFile(stepUrl)
+      const stepText = fsMap?.[stepUrl] ?? (await readStepFile(stepUrl))
       if (!stepText.trim()) {
         throw new Error("STEP file is empty")
       }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "circuit-json-to-step",
   "main": "dist/index.js",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "type": "module",
   "scripts": {
     "pull-reference": "git clone https://github.com/tscircuit/circuit-json.git && find circuit-json/tests -name '*.test.ts' -exec bash -c 'mv \"$0\" \"${0%.test.ts}.ts\"' {} \\; && git clone https://github.com/tscircuit/stepts.git && find stepts/tests -name '*.test.ts' -exec bash -c 'mv \"$0\" \"${0%.test.ts}.ts\"' {} \\;",
@@ -18,7 +18,7 @@
     "looks-same": "^10.0.1",
     "occt-import-js": "^0.0.23",
     "poppygl": "^0.0.13",
-    "stepts": "^0.0.1",
+    "stepts": "^0.0.2",
     "tsup": "^8.5.0"
   },
   "peerDependencies": {

package/test/repros/kicad-step/kicad-step.test.ts

@@ -4,6 +4,7 @@ import { join } from "node:path"
 import { circuitJsonToStep } from "../../../lib/index"
 import { importStepWithOcct } from "../../utils/occt/importer"
 import type { OcctMesh } from "../../utils/occt/importer"
+import { loadStepFilesFromCircuitJson } from "../../utils/load-step-files"
 import { parseRepository, ManifoldSolidBrep } from "stepts"
 import circuitJson from "./kicad-step.json"
 
@@ -90,10 +91,12 @@ test("kicad-step: switch fixture renders consistently", async () => {
 }, 30000)
 
 test("kicad-step: merges KiCad STEP models referenced via model_step_url", async () => {
+  const fsMap = await loadStepFilesFromCircuitJson(circuitJson)
   const stepText = await circuitJsonToStep(circuitJson as any, {
     includeComponents: true,
     includeExternalMeshes: true,
     productName: "KiCadStepMerge",
+    fsMap,
   })
 
   expect(stepText).toContain("KiCadStepMerge")

package/test/utils/load-step-files.ts

@@ -0,0 +1,41 @@
+/**
+ * Test utility for loading local STEP files.
+ * This file uses Node APIs and should only be imported in tests, not in lib.
+ */
+import { readFile } from "node:fs/promises"
+
+type CadComponent = {
+  type: string
+  model_step_url?: string
+}
+
+function isFilePath(value: string): boolean {
+  return !/^https?:\/\//i.test(value)
+}
+
+/**
+ * Loads all local STEP files referenced by cad_components in circuit JSON.
+ * Returns a map of file path to file content.
+ */
+export async function loadStepFilesFromCircuitJson(
+  circuitJson: unknown[],
+): Promise<Record<string, string>> {
+  const stepContents: Record<string, string> = {}
+  const stepFilePaths = new Set<string>()
+
+  for (const item of circuitJson as CadComponent[]) {
+    if (
+      item?.type === "cad_component" &&
+      item.model_step_url &&
+      isFilePath(item.model_step_url)
+    ) {
+      stepFilePaths.add(item.model_step_url)
+    }
+  }
+
+  for (const filePath of stepFilePaths) {
+    stepContents[filePath] = await readFile(filePath, "utf8")
+  }
+
+  return stepContents
+}