jscad-electronics 0.0.2 → 0.0.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 tscircuit Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,85 @@
 # jscad-electronics
 
-ELectronics CAD Components for use with [tscircuit](https://github.com/tscircuit/tscircuit)
+3D Electronic Component Models for JSCAD and tscircuit
+
+[![npm version](https://badge.fury.io/js/jscad-electronics.svg)](https://badge.fury.io/js/jscad-electronics)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+[Docs](https://docs.tscircuit.com) · [Website](https://tscircuit.com) · [Twitter](https://x.com/tscircuit) · [discord](https://tscircuit.com/community/join-redirect) · [Quickstart](https://docs.tscircuit.com/quickstart) · [Online Playground](https://tscircuit.com/playground)
+
+jscad-electronics is a library of 3D electronic component models for use with [JSCAD](https://github.com/jscad/OpenJSCAD.org) and [tscircuit](https://github.com/tscircuit/tscircuit). It provides accurate and customizable 3D models for various electronic components, making it easier to create 3D representations of PCBs and electronic assemblies.
+
+## Features
+
+- Wide range of electronic component models (e.g., resistors, capacitors, ICs, connectors)
+- Customizable dimensions and parameters for each component
+- Integration with tscircuit for advanced PCB design capabilities
+- Easy-to-use React components for JSCAD integration
+
+## Installation
+
+Install jscad-electronics using npm:
+
+```bash
+npm install jscad-electronics
+```
+
+## Usage
+
+Here's a basic example of how to use jscad-electronics with JSCAD:
+
+```jsx
+import { JsCadFixture } from "jscad-fiber"
+import { SOT233P, ExtrudedPads } from "jscad-electronics"
+
+export default () => {
+  return (
+    <JsCadFixture zAxisUp>
+      <SOT233P />
+      <ExtrudedPads footprint="sot23" />
+    </JsCadFixture>
+  )
+}
+```
+
+This example creates a 3D model of an SOT-23-3P component with extruded pads.
+
+## Available Components
+
+jscad-electronics includes models for various components, including:
+
+- Resistors (0402, 0603, 0805)
+- Capacitors
+- ICs (DIP, SOIC, TSSOP, QFN, QFP, BGA)
+- Diodes (SOD-123)
+- Transistors (SOT-23, SOT-563, SOT-723)
+- And more!
+
+Check the `lib` directory for a full list of available components.
+
+## Customization
+
+Most components accept parameters for customization. For example:
+
+```jsx
+<QFN fullWidth={4} height={0.8} thermalPadSize={2} />
+```
+
+Refer to the individual component files for available customization options.
+
+## Integration with tscircuit
+
+jscad-electronics is designed to work seamlessly with tscircuit. You can use these 3D models in your tscircuit projects to create accurate 3D representations of your PCB designs just by
+using the `footprint` prop
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Support
+
+If you encounter any problems or have any questions, please open an issue on the [GitHub repository](https://github.com/tscircuit/jscad-electronics/issues).

package/dist/index.js

@@ -77303,6 +77303,7 @@ var require_dist = __commonJS({
       Cylinder: () => Cylinder2,
       CylinderElliptic: () => CylinderElliptic,
       Ellipsoid: () => Ellipsoid,
+      ExtrudeFromSlices: () => ExtrudeFromSlices,
       ExtrudeHelical: () => ExtrudeHelical,
       ExtrudeLinear: () => ExtrudeLinear3,
       ExtrudeRectangular: () => ExtrudeRectangular,
@@ -77325,6 +77326,7 @@ var require_dist = __commonJS({
       convertCSGToThreeGeom: () => convertCSGToThreeGeom,
       createJSCADRenderer: () => createJSCADRenderer,
       normalizePointToArray: () => normalizePointToArray,
+      processRotation: () => processRotation,
       useRenderElementsToJscadPlan: () => useRenderElementsToJscadPlan
     });
     module.exports = __toCommonJS2(lib_exports);
@@ -77471,6 +77473,14 @@ var require_dist = __commonJS({
             );
             return extrudedGeometry;
           }
+          case "extrudeFromSlices": {
+            const { baseSlice, ...extrudeProps } = props;
+            const extrudedGeometry = jscad3.extrusions.extrudeFromSlices(
+              extrudeProps,
+              baseSlice
+            );
+            return extrudedGeometry;
+          }
           case "project": {
             const { children, ...projectProps } = props;
             const childrenGeometry = renderChildren(children);
@@ -77720,11 +77730,60 @@ var require_dist = __commonJS({
       return /* @__PURE__ */ (0, import_jsx_runtime82.jsx)("custom", { geometry });
     }
     var import_jsx_runtime92 = require_jsx_runtime();
-    var CylinderBase = ({ radius, height: height4 }) => {
-      return /* @__PURE__ */ (0, import_jsx_runtime92.jsx)("cylinder", { radius, height: height4 });
+    var convertToRadians = (value) => {
+      if (typeof value === "string") {
+        const numericValue = value.replace(/[^\d.-]/g, "");
+        const parsedValue = parseFloat(numericValue);
+        if (!isNaN(parsedValue)) {
+          if (value.toLowerCase().includes("deg")) {
+            return parsedValue * Math.PI / 180;
+          }
+          return parsedValue;
+        }
+        throw new Error(`Invalid rotation value: ${value}`);
+      }
+      return value;
+    };
+    var processRotation = (value) => {
+      if (typeof value === "string" || typeof value === "number") {
+        const angle = convertToRadians(value);
+        return [0, 0, angle];
+      } else if (Array.isArray(value)) {
+        return value.map(convertToRadians);
+      } else if (value && typeof value === "object") {
+        return [
+          convertToRadians(value.x),
+          convertToRadians(value.y),
+          convertToRadians(value.z)
+        ];
+      }
+      return [0, 0, 0];
+    };
+    var RotateBase = ({ rotation, angles, children }) => {
+      const finalRotation = rotation ? processRotation(rotation) : processRotation(angles);
+      return /* @__PURE__ */ (0, import_jsx_runtime92.jsx)("rotate", { angles: finalRotation, children });
     };
-    var Cylinder2 = withOffsetProp(withColorProp(CylinderBase));
+    var Rotate6 = withOffsetProp(withColorProp(RotateBase));
     var import_jsx_runtime102 = require_jsx_runtime();
+    function withRotationProp(WrappedComponent) {
+      const WithRotation = (props) => {
+        const { rotation, ...restProps } = props;
+        if (!rotation) {
+          return /* @__PURE__ */ (0, import_jsx_runtime102.jsx)(WrappedComponent, { ...restProps });
+        }
+        return /* @__PURE__ */ (0, import_jsx_runtime102.jsx)(Rotate6, { rotation, children: /* @__PURE__ */ (0, import_jsx_runtime102.jsx)(WrappedComponent, { ...restProps }) });
+      };
+      WithRotation.displayName = `WithRotation(${WrappedComponent.displayName || WrappedComponent.name || "Component"})`;
+      return WithRotation;
+    }
+    var import_jsx_runtime112 = require_jsx_runtime();
+    var CylinderBase = ({ radius, height: height4 }) => {
+      return /* @__PURE__ */ (0, import_jsx_runtime112.jsx)("cylinder", { radius, height: height4 });
+    };
+    var Cylinder2 = withColorProp(
+      withOffsetProp(withRotationProp(CylinderBase))
+    );
+    var import_jsx_runtime122 = require_jsx_runtime();
     var CylinderEllipticBase = ({
       height: height4,
       startRadius,
@@ -77733,7 +77792,7 @@ var require_dist = __commonJS({
       startAngle = 0,
       endAngle = Math.PI * 2
     }) => {
-      return /* @__PURE__ */ (0, import_jsx_runtime102.jsx)(
+      return /* @__PURE__ */ (0, import_jsx_runtime122.jsx)(
         "cylinderElliptic",
         {
           height: height4,
@@ -77748,12 +77807,12 @@ var require_dist = __commonJS({
     var CylinderElliptic = withOffsetProp(
       withColorProp(CylinderEllipticBase)
     );
-    var import_jsx_runtime112 = require_jsx_runtime();
+    var import_jsx_runtime132 = require_jsx_runtime();
     var EllipsoidBase = ({ radius }) => {
-      return /* @__PURE__ */ (0, import_jsx_runtime112.jsx)("ellipsoid", { radius });
+      return /* @__PURE__ */ (0, import_jsx_runtime132.jsx)("ellipsoid", { radius });
     };
     var Ellipsoid = withOffsetProp(withColorProp(EllipsoidBase));
-    var import_jsx_runtime122 = require_jsx_runtime();
+    var import_jsx_runtime142 = require_jsx_runtime();
     var ExtrudeHelicalBase = ({
       height: height4,
       angle,
@@ -77763,7 +77822,7 @@ var require_dist = __commonJS({
       segmetsPerRotation,
       children
     }) => {
-      return /* @__PURE__ */ (0, import_jsx_runtime122.jsx)(
+      return /* @__PURE__ */ (0, import_jsx_runtime142.jsx)(
         "extrudeHelical",
         {
           height: height4,
@@ -77777,14 +77836,14 @@ var require_dist = __commonJS({
       );
     };
     var ExtrudeHelical = withOffsetProp(withColorProp(ExtrudeHelicalBase));
-    var import_jsx_runtime132 = require_jsx_runtime();
+    var import_jsx_runtime152 = require_jsx_runtime();
     var ExtrudeLinearBase = ({
       height: height4,
       twistAngle,
       twistSteps,
       children
     }) => {
-      return /* @__PURE__ */ (0, import_jsx_runtime132.jsx)(
+      return /* @__PURE__ */ (0, import_jsx_runtime152.jsx)(
         "extrudeLinear",
         {
           height: height4,
@@ -77795,101 +77854,66 @@ var require_dist = __commonJS({
       );
     };
     var ExtrudeLinear3 = withOffsetProp(withColorProp(ExtrudeLinearBase));
-    var import_jsx_runtime142 = require_jsx_runtime();
+    var import_jsx_runtime162 = require_jsx_runtime();
     var ExtrudeRectangularBase = ({
       size,
       height: height4,
       children
     }) => {
-      return /* @__PURE__ */ (0, import_jsx_runtime142.jsx)("extrudeRectangular", { size, height: height4, children });
+      return /* @__PURE__ */ (0, import_jsx_runtime162.jsx)("extrudeRectangular", { size, height: height4, children });
     };
     var ExtrudeRectangular = withOffsetProp(
       withColorProp(ExtrudeRectangularBase)
     );
-    var import_jsx_runtime152 = require_jsx_runtime();
+    var import_jsx_runtime172 = require_jsx_runtime();
     var ExtrudeRotateBase = ({
       angle,
       startAngle,
       segments,
       children
     }) => {
-      return /* @__PURE__ */ (0, import_jsx_runtime152.jsx)("extrudeRotate", { angle, startAngle, segments, children });
+      return /* @__PURE__ */ (0, import_jsx_runtime172.jsx)("extrudeRotate", { angle, startAngle, segments, children });
     };
     var ExtrudeRotate = withOffsetProp(withColorProp(ExtrudeRotateBase));
-    var import_jsx_runtime162 = require_jsx_runtime();
+    var import_jsx_runtime182 = require_jsx_runtime();
     var GeodesicSphereBase = ({ radius, frequency }) => {
-      return /* @__PURE__ */ (0, import_jsx_runtime162.jsx)("geodesicSphere", { radius, frequency });
+      return /* @__PURE__ */ (0, import_jsx_runtime182.jsx)("geodesicSphere", { radius, frequency });
     };
     var GeodesicSphere = withOffsetProp(withColorProp(GeodesicSphereBase));
-    var import_jsx_runtime172 = require_jsx_runtime();
+    var import_jsx_runtime192 = require_jsx_runtime();
     var HullBase = ({ children }) => {
-      return /* @__PURE__ */ (0, import_jsx_runtime172.jsx)("hull", { children });
+      return /* @__PURE__ */ (0, import_jsx_runtime192.jsx)("hull", { children });
     };
     var Hull = withOffsetProp(withColorProp(HullBase));
-    var import_jsx_runtime182 = require_jsx_runtime();
+    var import_jsx_runtime20 = require_jsx_runtime();
     var HullChainBase = ({ children }) => {
-      return /* @__PURE__ */ (0, import_jsx_runtime182.jsx)("hullChain", { children });
+      return /* @__PURE__ */ (0, import_jsx_runtime20.jsx)("hullChain", { children });
     };
     var HullChain = withOffsetProp(withColorProp(HullChainBase));
-    var import_jsx_runtime192 = require_jsx_runtime();
+    var import_jsx_runtime21 = require_jsx_runtime();
     function Polygon3({ points }) {
-      return /* @__PURE__ */ (0, import_jsx_runtime192.jsx)("jscadPolygon", { points });
+      return /* @__PURE__ */ (0, import_jsx_runtime21.jsx)("jscadPolygon", { points });
     }
-    var import_jsx_runtime20 = require_jsx_runtime();
+    var import_jsx_runtime222 = require_jsx_runtime();
     function Project({ axis, origin, children }) {
-      return /* @__PURE__ */ (0, import_jsx_runtime20.jsx)("project", { axis, origin, children });
+      return /* @__PURE__ */ (0, import_jsx_runtime222.jsx)("project", { axis, origin, children });
     }
-    var import_jsx_runtime21 = require_jsx_runtime();
+    var import_jsx_runtime23 = require_jsx_runtime();
     function Rectangle({ size }) {
-      return /* @__PURE__ */ (0, import_jsx_runtime21.jsx)("rectangle", { size });
+      return /* @__PURE__ */ (0, import_jsx_runtime23.jsx)("rectangle", { size });
     }
-    var import_jsx_runtime222 = require_jsx_runtime();
-    var convertToRadians = (value) => {
-      if (typeof value === "string") {
-        const numericValue = value.replace(/[^\d.-]/g, "");
-        const parsedValue = parseFloat(numericValue);
-        if (!isNaN(parsedValue)) {
-          if (value.toLowerCase().includes("deg")) {
-            return parsedValue * Math.PI / 180;
-          }
-          return parsedValue;
-        }
-        throw new Error(`Invalid rotation value: ${value}`);
-      }
-      return value;
-    };
-    var RotateBase = ({ rotation, angles, children }) => {
-      const processRotation = (value) => {
-        if (typeof value === "string" || typeof value === "number") {
-          const angle = convertToRadians(value);
-          return [0, 0, angle];
-        } else if (Array.isArray(value)) {
-          return value.map(convertToRadians);
-        } else if (value && typeof value === "object") {
-          return [
-            convertToRadians(value.x),
-            convertToRadians(value.y),
-            convertToRadians(value.z)
-          ];
-        }
-        return [0, 0, 0];
-      };
-      const finalRotation = rotation ? processRotation(rotation) : processRotation(angles);
-      return /* @__PURE__ */ (0, import_jsx_runtime222.jsx)("rotate", { angles: finalRotation, children });
-    };
-    var Rotate6 = withOffsetProp(withColorProp(RotateBase));
-    var import_jsx_runtime23 = require_jsx_runtime();
+    var import_jsx_runtime24 = require_jsx_runtime();
     var RoundedCuboidBase = ({ size, roundRadius }) => {
-      return /* @__PURE__ */ (0, import_jsx_runtime23.jsx)("roundedCuboid", { size, roundRadius });
+      return /* @__PURE__ */ (0, import_jsx_runtime24.jsx)("roundedCuboid", { size, roundRadius });
     };
     var RoundedCuboid2 = withOffsetProp(withColorProp(RoundedCuboidBase));
-    var import_jsx_runtime24 = require_jsx_runtime();
+    var import_jsx_runtime25 = require_jsx_runtime();
     var RoundedCylinderBase = ({
       radius,
       height: height4,
       roundRadius
     }) => {
-      return /* @__PURE__ */ (0, import_jsx_runtime24.jsx)(
+      return /* @__PURE__ */ (0, import_jsx_runtime25.jsx)(
         "roundedCylinder",
         {
           radius,
@@ -77901,12 +77925,12 @@ var require_dist = __commonJS({
     var RoundedCylinder = withOffsetProp(
       withColorProp(RoundedCylinderBase)
     );
-    var import_jsx_runtime25 = require_jsx_runtime();
+    var import_jsx_runtime26 = require_jsx_runtime();
     var SphereBase = ({ radius, segments }) => {
-      return /* @__PURE__ */ (0, import_jsx_runtime25.jsx)("sphere", { radius, segments: segments || 32 });
+      return /* @__PURE__ */ (0, import_jsx_runtime26.jsx)("sphere", { radius, segments: segments || 32 });
     };
-    var Sphere2 = withColorProp(SphereBase);
-    var import_jsx_runtime26 = require_jsx_runtime();
+    var Sphere2 = withColorProp(withOffsetProp(SphereBase));
+    var import_jsx_runtime27 = require_jsx_runtime();
     var TorusBase = ({
       innerRadius,
       outerRadius,
@@ -77916,7 +77940,7 @@ var require_dist = __commonJS({
       outerRotation = 1,
       startAngle = 0
     }) => {
-      return /* @__PURE__ */ (0, import_jsx_runtime26.jsx)(
+      return /* @__PURE__ */ (0, import_jsx_runtime27.jsx)(
         "torus",
         {
           innerRadius,
@@ -77930,10 +77954,36 @@ var require_dist = __commonJS({
       );
     };
     var Torus = withOffsetProp(withColorProp(TorusBase));
-    var import_jsx_runtime27 = require_jsx_runtime();
+    var import_jsx_runtime28 = require_jsx_runtime();
     function Union3({ children }) {
-      return /* @__PURE__ */ (0, import_jsx_runtime27.jsx)("union", { children });
+      return /* @__PURE__ */ (0, import_jsx_runtime28.jsx)("union", { children });
     }
+    var import_jsx_runtime29 = require_jsx_runtime();
+    var ExtrudeFromSlicesBase = ({
+      numberOfSlices,
+      capStart,
+      capEnd,
+      close,
+      repair,
+      baseSlice,
+      callback
+    }) => {
+      return /* @__PURE__ */ (0, import_jsx_runtime29.jsx)(
+        "extrudeFromSlices",
+        {
+          numberOfSlices,
+          capStart,
+          capEnd,
+          close,
+          repair,
+          baseSlice,
+          callback
+        }
+      );
+    };
+    var ExtrudeFromSlices = withOffsetProp(
+      withColorProp(ExtrudeFromSlicesBase)
+    );
     var jscad = __toESM2(require_src(), 1);
     var import_react2 = __toESM2(require_react(), 1);
     var THREE = __toESM2(require_three(), 1);
@@ -78016,7 +78066,7 @@ var require_dist = __commonJS({
       return new import_three2.BufferGeometry();
     }
     var convert_csg_to_three_geom_default = convertCSGToThreeGeom;
-    var import_jsx_runtime28 = require_jsx_runtime();
+    var import_jsx_runtime30 = require_jsx_runtime();
     var { createJSCADRoot } = createJSCADRenderer(jscad);
     function JsCadFixture({
       children,
@@ -78111,7 +78161,7 @@ var require_dist = __commonJS({
           gridRef.current.visible = showGrid;
         }
       }, [showGrid]);
-      return /* @__PURE__ */ (0, import_jsx_runtime28.jsx)("div", { ref: containerRef, style: { width: "100%", minHeight: "400px" } });
+      return /* @__PURE__ */ (0, import_jsx_runtime30.jsx)("div", { ref: containerRef, style: { width: "100%", minHeight: "400px" } });
     }
     var jscad2 = __toESM2(require_src(), 1);
     var import_react22 = require_react();
@@ -78163,7 +78213,7 @@ var require_dist = __commonJS({
       }, [children, root, container]);
       return mesh;
     }
-    var import_jsx_runtime29 = require_jsx_runtime();
+    var import_jsx_runtime31 = require_jsx_runtime();
     function JSCadThreeMesh({
       children
     }) {
@@ -78171,7 +78221,7 @@ var require_dist = __commonJS({
       if (!mesh) {
         return null;
       }
-      return /* @__PURE__ */ (0, import_jsx_runtime29.jsx)("primitive", { object: mesh });
+      return /* @__PURE__ */ (0, import_jsx_runtime31.jsx)("primitive", { object: mesh });
     }
     var import_react3 = __toESM2(require_react(), 1);
     var useRenderElementsToJscadPlan = (jscad3, children) => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "jscad-electronics",
   "type": "module",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "main": "./dist/index.js",
   "repository": {
     "type": "git",
@@ -23,7 +23,7 @@
     "@tscircuit/soup": "^0.0.41",
     "@types/react": "^18.3.10",
     "@types/react-dom": "^18.3.0",
-    "jscad-fiber": "^0.0.64",
+    "jscad-fiber": "^0.0.67",
     "react": "^18.3.1",
     "react-cosmos": "^6.1.1",
     "react-cosmos-plugin-vite": "^6.1.1",
@@ -33,6 +33,6 @@
     "vite-tsconfig-paths": "^5.0.1"
   },
   "dependencies": {
-    "@tscircuit/footprinter": "^0.0.63"
+    "@tscircuit/footprinter": "^0.0.64"
   }
 }