circuit-json-to-tscircuit 0.0.49 → 0.0.50

package/dist/{chunk-YHGRHULT.js → chunk-6TIIS52N.js}

@@ -869,6 +869,83 @@ var generateSymbolTsx = (circuitJson) => {
   `.trim();
 };
 
+// lib/get-pin-attributes.ts
+var attributeNames = {
+  is_input: "isInput",
+  is_output: "isOutput",
+  is_bidirectional: "isBidirectional",
+  is_passive: "isPassive",
+  can_use_tri_state: "canUseTriState",
+  is_using_tri_state: "isUsingTriState",
+  can_use_open_collector: "canUseOpenCollector",
+  is_using_open_collector: "isUsingOpenCollector",
+  can_use_open_emitter: "canUseOpenEmitter",
+  is_using_open_emitter: "isUsingOpenEmitter",
+  is_gpio: "isGpio",
+  highlight_color: "highlightColor",
+  must_be_connected: "mustBeConnected",
+  provides_power: "providesPower",
+  requires_power: "requiresPower",
+  provides_ground: "providesGround",
+  requires_ground: "requiresGround",
+  provides_voltage: "providesVoltage",
+  requires_voltage: "requiresVoltage",
+  do_not_connect: "doNotConnect",
+  include_in_board_pinout: "includeInBoardPinout",
+  can_use_internal_pullup: "canUseInternalPullup",
+  is_using_internal_pullup: "isUsingInternalPullup",
+  needs_external_pullup: "needsExternalPullup",
+  can_use_internal_pulldown: "canUseInternalPulldown",
+  is_using_internal_pulldown: "isUsingInternalPulldown",
+  needs_external_pulldown: "needsExternalPulldown",
+  can_use_open_drain: "canUseOpenDrain",
+  is_using_open_drain: "isUsingOpenDrain",
+  can_use_push_pull: "canUsePushPull",
+  is_using_push_pull: "isUsingPushPull",
+  should_have_decoupling_capacitor: "shouldHaveDecouplingCapacitor",
+  recommended_decoupling_capacitor_capacitance: "recommendedDecouplingCapacitorCapacitance"
+};
+var capabilities = [
+  "i2c_sda",
+  "i2c_scl",
+  "spi_mosi",
+  "spi_miso",
+  "spi_sck",
+  "spi_cs",
+  "uart_tx",
+  "uart_rx"
+];
+var getPinAttributes = (circuitJson) => {
+  const components = circuitJson.filter((e) => e.type === "source_component");
+  if (components.length > 1) return void 0;
+  const componentId = components[0]?.source_component_id;
+  const pins = /* @__PURE__ */ new Map();
+  for (const port of circuitJson) {
+    if (port.type !== "source_port") continue;
+    if (componentId && port.source_component_id && port.source_component_id !== componentId)
+      continue;
+    const source = { ...port };
+    const attributes = {};
+    for (const [sourceName, propName] of Object.entries(attributeNames)) {
+      if (source[sourceName] !== void 0) {
+        attributes[propName] = source[sourceName];
+      }
+    }
+    const supported = capabilities.filter(
+      (c) => source[`supports_${c}`] === true
+    );
+    const active = capabilities.filter(
+      (c) => source[`is_configured_for_${c}`] === true
+    );
+    if (supported.length) attributes.capabilities = supported;
+    if (active.length) attributes.activeCapabilities = active;
+    if (Object.keys(attributes).length === 0) continue;
+    const key = port.pin_number !== void 0 ? `pin${port.pin_number}` : port.name;
+    pins.set(key, { ...pins.get(key), ...attributes });
+  }
+  return pins.size ? Object.fromEntries(pins) : void 0;
+};
+
 // lib/get-component-using-template.ts
 var getComponentUsingTemplate = ({
   pinLabels,
@@ -880,6 +957,7 @@ var getComponentUsingTemplate = ({
 }) => {
   const footprintTsx = generateFootprintTsx(circuitJson);
   const symbolTsx = generateSymbolTsx(circuitJson);
+  const pinAttributes = getPinAttributes(circuitJson);
   return `
 import { type ChipProps } from "tscircuit"
 ${pinLabels ? `const pinLabels = ${JSON.stringify(pinLabels, null, "  ")} as const
@@ -888,6 +966,7 @@ ${pinLabels ? `const pinLabels = ${JSON.stringify(pinLabels, null, "  ")} as con
     ${footprintTsx ? `footprint={${footprintTsx}}` : ""}
     ${symbolTsx ? `symbol={${symbolTsx}}` : ""}
     ${pinLabels ? "pinLabels={pinLabels}" : ""}
+    ${pinAttributes ? `pinAttributes={${JSON.stringify(pinAttributes, null, "  ")}}` : ""}
     ${objUrl ? `cadModel={{
         objUrl: "${objUrl}",
         rotationOffset: { x: 0, y: 0, z: 0 },

package/dist/cli/main.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import {
   convertCircuitJsonToTscircuit
-} from "../chunk-YHGRHULT.js";
+} from "../chunk-6TIIS52N.js";
 
 // cli/main.ts
 import { Command } from "commander";
@@ -16,7 +16,7 @@ var package_default = {
     "./cli": "./dist/cli/main.js"
   },
   type: "module",
-  version: "0.0.48",
+  version: "0.0.49",
   repository: {
     type: "git",
     url: "https://github.com/tscircuit/circuit-json-to-tscircuit.git"

package/dist/lib/index.js

@@ -1,6 +1,6 @@
 import {
   convertCircuitJsonToTscircuit
-} from "../chunk-YHGRHULT.js";
+} from "../chunk-6TIIS52N.js";
 export {
   convertCircuitJsonToTscircuit
 };

package/lib/get-component-using-template.ts

@@ -1,6 +1,7 @@
 import type { AnyCircuitElement } from "circuit-json"
 import { generateFootprintTsx } from "./generate-footprint-tsx"
 import { generateSymbolTsx } from "./generate-symbol-tsx"
+import { getPinAttributes } from "./get-pin-attributes"
 
 export interface ComponentTemplateParams {
   pinLabels?: Record<string, string[]> | Record<string, string> // ChipProps["pinLabels"]
@@ -21,6 +22,7 @@ export const getComponentUsingTemplate = ({
 }: ComponentTemplateParams) => {
   const footprintTsx = generateFootprintTsx(circuitJson)
   const symbolTsx = generateSymbolTsx(circuitJson)
+  const pinAttributes = getPinAttributes(circuitJson)
   return `
 import { type ChipProps } from "tscircuit"
 ${pinLabels ? `const pinLabels = ${JSON.stringify(pinLabels, null, "  ")} as const\n` : ""}export const ${componentName} = (props: ChipProps${pinLabels ? `<typeof pinLabels>` : ""}) => (
@@ -28,6 +30,7 @@ ${pinLabels ? `const pinLabels = ${JSON.stringify(pinLabels, null, "  ")} as con
     ${footprintTsx ? `footprint={${footprintTsx}}` : ""}
     ${symbolTsx ? `symbol={${symbolTsx}}` : ""}
     ${pinLabels ? "pinLabels={pinLabels}" : ""}
+    ${pinAttributes ? `pinAttributes={${JSON.stringify(pinAttributes, null, "  ")}}` : ""}
     ${objUrl ? `cadModel={{\n        objUrl: \"${objUrl}\",\n        rotationOffset: { x: 0, y: 0, z: 0 },\n        positionOffset: { x: 0, y: 0, z: 0 },\n      }}` : ""}
     ${supplierPartNumbers ? `supplierPartNumbers={${JSON.stringify(supplierPartNumbers, null, "  ")}}` : ""}
     ${manufacturerPartNumber ? `manufacturerPartNumber=\"${manufacturerPartNumber}\"` : ""}

package/lib/get-pin-attributes.ts

@@ -0,0 +1,91 @@
+import type { AnyCircuitElement } from "circuit-json"
+
+// Explicitly select electrical attributes; source-port IDs and other metadata
+// must not become chip props. Newer Circuit JSON fields are read without parsing
+// through an older schema, which would strip them from imported JSON.
+const attributeNames = {
+  is_input: "isInput",
+  is_output: "isOutput",
+  is_bidirectional: "isBidirectional",
+  is_passive: "isPassive",
+  can_use_tri_state: "canUseTriState",
+  is_using_tri_state: "isUsingTriState",
+  can_use_open_collector: "canUseOpenCollector",
+  is_using_open_collector: "isUsingOpenCollector",
+  can_use_open_emitter: "canUseOpenEmitter",
+  is_using_open_emitter: "isUsingOpenEmitter",
+  is_gpio: "isGpio",
+  highlight_color: "highlightColor",
+  must_be_connected: "mustBeConnected",
+  provides_power: "providesPower",
+  requires_power: "requiresPower",
+  provides_ground: "providesGround",
+  requires_ground: "requiresGround",
+  provides_voltage: "providesVoltage",
+  requires_voltage: "requiresVoltage",
+  do_not_connect: "doNotConnect",
+  include_in_board_pinout: "includeInBoardPinout",
+  can_use_internal_pullup: "canUseInternalPullup",
+  is_using_internal_pullup: "isUsingInternalPullup",
+  needs_external_pullup: "needsExternalPullup",
+  can_use_internal_pulldown: "canUseInternalPulldown",
+  is_using_internal_pulldown: "isUsingInternalPulldown",
+  needs_external_pulldown: "needsExternalPulldown",
+  can_use_open_drain: "canUseOpenDrain",
+  is_using_open_drain: "isUsingOpenDrain",
+  can_use_push_pull: "canUsePushPull",
+  is_using_push_pull: "isUsingPushPull",
+  should_have_decoupling_capacitor: "shouldHaveDecouplingCapacitor",
+  recommended_decoupling_capacitor_capacitance:
+    "recommendedDecouplingCapacitorCapacitance",
+} as const
+
+const capabilities = [
+  "i2c_sda",
+  "i2c_scl",
+  "spi_mosi",
+  "spi_miso",
+  "spi_sck",
+  "spi_cs",
+  "uart_tx",
+  "uart_rx",
+] as const
+
+/** Electrical props for the single component represented by a chip template. */
+export const getPinAttributes = (circuitJson: AnyCircuitElement[]) => {
+  const components = circuitJson.filter((e) => e.type === "source_component")
+  // Pin numbers are local to a component. Never combine multiple components'
+  // attributes into a single chip.
+  if (components.length > 1) return undefined
+  const componentId = components[0]?.source_component_id
+  const pins = new Map<string, Record<string, unknown>>()
+  for (const port of circuitJson) {
+    if (port.type !== "source_port") continue
+    if (
+      componentId &&
+      port.source_component_id &&
+      port.source_component_id !== componentId
+    )
+      continue
+    const source: Record<string, unknown> = { ...port }
+    const attributes: Record<string, unknown> = {}
+    for (const [sourceName, propName] of Object.entries(attributeNames)) {
+      if (source[sourceName] !== undefined) {
+        attributes[propName] = source[sourceName]
+      }
+    }
+    const supported = capabilities.filter(
+      (c) => source[`supports_${c}`] === true,
+    )
+    const active = capabilities.filter(
+      (c) => source[`is_configured_for_${c}`] === true,
+    )
+    if (supported.length) attributes.capabilities = supported
+    if (active.length) attributes.activeCapabilities = active
+    if (Object.keys(attributes).length === 0) continue
+    const key =
+      port.pin_number !== undefined ? `pin${port.pin_number}` : port.name
+    pins.set(key, { ...pins.get(key), ...attributes })
+  }
+  return pins.size ? Object.fromEntries(pins) : undefined
+}

package/package.json

@@ -6,7 +6,7 @@
     "./cli": "./dist/cli/main.js"
   },
   "type": "module",
-  "version": "0.0.49",
+  "version": "0.0.50",
   "repository": {
     "type": "git",
     "url": "https://github.com/tscircuit/circuit-json-to-tscircuit.git"

package/tests/fixtures/pin-attributes/ap2127k-2.8trg1.json

@@ -0,0 +1,91 @@
+{
+  "circuitJson": [
+    {
+      "type": "source_component",
+      "ftype": "simple_chip",
+      "source_component_id": "source_component_1",
+      "name": "U1",
+      "manufacturer_part_number": "AP2127K-28TRG1"
+    },
+    {
+      "type": "source_port",
+      "source_port_id": "source_port_1",
+      "source_component_id": "source_component_1",
+      "name": "pin1",
+      "pin_number": 1,
+      "port_hints": ["VIN"],
+      "must_be_connected": true,
+      "requires_power": true,
+      "should_have_decoupling_capacitor": true,
+      "recommended_decoupling_capacitor_capacitance": "1uF"
+    },
+    {
+      "type": "source_port",
+      "source_port_id": "source_port_2",
+      "source_component_id": "source_component_1",
+      "name": "pin2",
+      "pin_number": 2,
+      "port_hints": ["GND"],
+      "must_be_connected": true,
+      "requires_ground": true
+    },
+    {
+      "type": "source_port",
+      "source_port_id": "source_port_3",
+      "source_component_id": "source_component_1",
+      "name": "pin3",
+      "pin_number": 3,
+      "port_hints": ["N_SHUTDOWN"],
+      "is_input": true,
+      "must_be_connected": true
+    },
+    {
+      "type": "source_port",
+      "source_port_id": "source_port_4",
+      "source_component_id": "source_component_1",
+      "name": "pin4",
+      "pin_number": 4,
+      "port_hints": ["NC"],
+      "do_not_connect": true
+    },
+    {
+      "type": "source_port",
+      "source_port_id": "source_port_5",
+      "source_component_id": "source_component_1",
+      "name": "pin5",
+      "pin_number": 5,
+      "port_hints": ["VOUT"],
+      "is_output": true,
+      "provides_power": true,
+      "provides_voltage": 2.8,
+      "should_have_decoupling_capacitor": true,
+      "recommended_decoupling_capacitor_capacitance": "1uF"
+    }
+  ],
+  "pinAttributes": {
+    "pin1": {
+      "requiresPower": true,
+      "mustBeConnected": true,
+      "shouldHaveDecouplingCapacitor": true,
+      "recommendedDecouplingCapacitorCapacitance": "1uF"
+    },
+    "pin2": {
+      "requiresGround": true,
+      "mustBeConnected": true
+    },
+    "pin3": {
+      "isInput": true,
+      "mustBeConnected": true
+    },
+    "pin4": {
+      "doNotConnect": true
+    },
+    "pin5": {
+      "isOutput": true,
+      "providesPower": true,
+      "providesVoltage": 2.8,
+      "shouldHaveDecouplingCapacitor": true,
+      "recommendedDecouplingCapacitorCapacitance": "1uF"
+    }
+  }
+}