@bitbybit-dev/jscad 1.3.2 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  [JSCAD](https://github.com/jscad) solid modeling integration for [Bitbybit](https://bitbybit.dev) - programmatic CSG operations, extrusions, hulls, and more for creating precise 3D geometry through code.
4
4
 
5
- <img src="https://app.bitbybit.dev/assets/git-cover.png" alt="Picture showing bitbybit.dev platform">
5
+ <img src="https://bitbybit.dev/files/site/git-cover.png" alt="Picture showing bitbybit.dev platform">
6
6
 
7
7
  ## Overview
8
8
 
@@ -0,0 +1,8 @@
1
+ import { DtoRegistry } from "@bitbybit-dev/base";
2
+ /**
3
+ * Every public operation of the JSCAD kernel by its dotted path, the inputs DTO it
4
+ * takes, and what each property of that DTO accepts. `resolveInputs` from the base package reads
5
+ * it to lay a caller's properties over that DTO's defaults before the kernel runs, and
6
+ * `validateInputs` to check what the call was given.
7
+ */
8
+ export declare const jscadDtoRegistry: DtoRegistry;
@@ -0,0 +1,139 @@
1
+ // GENERATED by scripts/gen-dto-meta.mjs from the Jscad surface - do not edit.
2
+ // Regenerate with `npm run gen:dto-meta` at the repository root.
3
+ import { constraintKinds as k } from "@bitbybit-dev/base";
4
+ import * as Inputs from "./inputs";
5
+ const JSCAD_BooleanObjectsDto = { meshes: k.required(k.list(k.opaque)) };
6
+ const JSCAD_BooleanObjectsFromDto = { from: k.required(k.opaque), meshes: k.required(k.list(k.opaque)) };
7
+ const JSCAD_BooleanTwoObjectsDto = { first: k.required(k.opaque), second: k.required(k.opaque) };
8
+ const JSCAD_CircleDto = { center: k.point2, radius: k.between(k.number, { min: 0 }), segments: k.between(k.number, { min: 3 }) };
9
+ const JSCAD_ColorizeDto = { geometry: k.required(k.opaque), color: k.string };
10
+ const JSCAD_CubeCentersDto = { centers: k.required(k.list(k.point3)), size: k.between(k.number, { min: 0 }) };
11
+ const JSCAD_CubeDto = { center: k.point3, size: k.between(k.number, { min: 0 }) };
12
+ const JSCAD_CuboidCentersDto = { centers: k.required(k.list(k.point3)), width: k.between(k.number, { min: 0 }), length: k.between(k.number, { min: 0 }), height: k.between(k.number, { min: 0 }) };
13
+ const JSCAD_CuboidDto = { center: k.point3, width: k.between(k.number, { min: 0 }), length: k.between(k.number, { min: 0 }), height: k.between(k.number, { min: 0 }) };
14
+ const JSCAD_CurveDto = { curve: k.required(k.opaque) };
15
+ const JSCAD_CylidnerCentersDto = { centers: k.required(k.list(k.point3)), height: k.between(k.number, { min: 0 }), radius: k.between(k.number, { min: 0 }), segments: k.between(k.number, { min: 4 }) };
16
+ const JSCAD_CylidnerCentersEllipticDto = { centers: k.required(k.list(k.point3)), height: k.between(k.number, { min: 0, exclusiveMin: true }), startRadius: k.point2, endRadius: k.point2, segments: k.between(k.number, { min: 4 }) };
17
+ const JSCAD_CylidnerDto = { center: k.point3, height: k.between(k.number, { min: 0 }), radius: k.between(k.number, { min: 0 }), segments: k.between(k.number, { min: 4 }) };
18
+ const JSCAD_CylidnerEllipticDto = { center: k.point3, height: k.between(k.number, { min: 0, exclusiveMin: true }), startRadius: k.vector2, endRadius: k.vector2, segments: k.between(k.number, { min: 4 }) };
19
+ const JSCAD_CylinderTextDto = { text: k.string, extrusionHeight: k.between(k.number, { min: 0 }), extrusionSize: k.between(k.number, { min: 0 }), segments: k.between(k.number, { min: 4 }), xOffset: k.number, yOffset: k.number, height: k.between(k.number, { min: 0 }), lineSpacing: k.number, letterSpacing: k.number, align: k.oneOf(["left", "center", "right"]), extrudeOffset: k.number };
20
+ const JSCAD_DownloadGeometryDto = { geometry: k.required(k.opaque), fileName: k.string, options: k.opaque };
21
+ const JSCAD_DownloadSolidDto = { mesh: k.required(k.opaque), fileName: k.required(k.string) };
22
+ const JSCAD_DownloadSolidsDto = { meshes: k.required(k.list(k.opaque)), fileName: k.required(k.string) };
23
+ const JSCAD_EllipseDto = { center: k.point2, radius: k.point2, segments: k.between(k.number, { min: 3 }) };
24
+ const JSCAD_EllipsoidCentersDto = { centers: k.required(k.list(k.point3)), radius: k.point3, segments: k.between(k.number, { min: 4 }) };
25
+ const JSCAD_EllipsoidDto = { center: k.point3, radius: k.point3, segments: k.between(k.number, { min: 4 }) };
26
+ const JSCAD_ExpandDto = { geometry: k.required(k.opaque), delta: k.number, corners: k.oneOf(["edge", "round", "chamfer"]), segments: k.between(k.number, { min: 0 }) };
27
+ const JSCAD_ExpansionDto = { geometry: k.required(k.opaque), delta: k.number, corners: k.oneOf(["edge", "round", "chamfer"]), segments: k.between(k.number, { min: 0 }) };
28
+ const JSCAD_ExtrudeLinearDto = { geometry: k.required(k.opaque), height: k.number, twistAngle: k.number, twistSteps: k.between(k.number, { min: 1 }) };
29
+ const JSCAD_ExtrudeRectangularDto = { geometry: k.required(k.opaque), height: k.between(k.number, { min: 0, exclusiveMin: true }), size: k.between(k.number, { min: 0, exclusiveMin: true }) };
30
+ const JSCAD_ExtrudeRectangularPointsDto = { points: k.required(k.list(k.point3)), height: k.between(k.number, { min: 0, exclusiveMin: true }), size: k.between(k.number, { min: 0, exclusiveMin: true }) };
31
+ const JSCAD_ExtrudeRotateDto = { polygon: k.required(k.opaque), angle: k.number, startAngle: k.number, segments: k.between(k.number, { min: 3 }) };
32
+ const JSCAD_FromPolygonPoints = { polygonPoints: k.required(k.list(k.list(k.point3))) };
33
+ const JSCAD_GeodesicSphereCentersDto = { centers: k.required(k.list(k.point3)), radius: k.between(k.number, { min: 0 }), frequency: k.between(k.number, { min: 6 }) };
34
+ const JSCAD_GeodesicSphereDto = { center: k.point3, radius: k.between(k.number, { min: 0 }), frequency: k.between(k.number, { min: 6 }) };
35
+ const JSCAD_HullDto = { meshes: k.required(k.list(k.opaque)) };
36
+ const JSCAD_MeshDto = { mesh: k.required(k.opaque) };
37
+ const JSCAD_MeshesDto = { meshes: k.required(k.list(k.opaque)) };
38
+ const JSCAD_MinkowskiSumDto = { meshes: k.required(k.list(k.opaque)) };
39
+ const JSCAD_PathAppendArcDto = { path: k.required(k.opaque), endPoint: k.point2, xAxisRotation: k.number, clockwise: k.boolean, large: k.boolean, segments: k.between(k.number, { min: 4 }), radiusX: k.between(k.number, { min: 0 }), radiusY: k.between(k.number, { min: 0 }) };
40
+ const JSCAD_PathAppendPointsDto = { points: k.required(k.list(k.point2)), path: k.required(k.opaque) };
41
+ const JSCAD_PathAppendPolylineDto = { polyline: k.required(k.opaque), path: k.required(k.opaque) };
42
+ const JSCAD_PathDto = { path: k.required(k.opaque) };
43
+ const JSCAD_PathFromPointsDto = { points: k.required(k.list(k.point2)), closed: k.boolean };
44
+ const JSCAD_PathFromPolylineDto = { polyline: k.required(k.opaque), closed: k.boolean };
45
+ const JSCAD_PathsFromPointsDto = { pointsLists: k.required(k.opaque) };
46
+ const JSCAD_PointsDto = { points: k.required(k.list(k.point)) };
47
+ const JSCAD_PolylineDto = { polyline: k.required(k.opaque) };
48
+ const JSCAD_RectangleDto = { center: k.point2, width: k.between(k.number, { min: 0 }), length: k.between(k.number, { min: 0 }) };
49
+ const JSCAD_RoundedCuboidCentersDto = { centers: k.required(k.list(k.point3)), roundRadius: k.between(k.number, { min: 0 }), width: k.between(k.number, { min: 0 }), length: k.between(k.number, { min: 0 }), height: k.between(k.number, { min: 0 }), segments: k.between(k.number, { min: 4 }) };
50
+ const JSCAD_RoundedCuboidDto = { center: k.point3, roundRadius: k.between(k.number, { min: 0 }), width: k.between(k.number, { min: 0 }), length: k.between(k.number, { min: 0 }), height: k.between(k.number, { min: 0 }), segments: k.between(k.number, { min: 4 }) };
51
+ const JSCAD_RoundedCylidnerCentersDto = { centers: k.required(k.list(k.point3)), roundRadius: k.between(k.number, { min: 0 }), height: k.between(k.number, { min: 0 }), radius: k.between(k.number, { min: 0 }), segments: k.between(k.number, { min: 4 }) };
52
+ const JSCAD_RoundedCylidnerDto = { center: k.point3, roundRadius: k.between(k.number, { min: 0 }), height: k.between(k.number, { min: 0 }), radius: k.between(k.number, { min: 0 }), segments: k.between(k.number, { min: 4 }) };
53
+ const JSCAD_RoundedRectangleDto = { center: k.point2, roundRadius: k.between(k.number, { min: 0 }), segments: k.between(k.number, { min: 4 }), width: k.between(k.number, { min: 0 }), length: k.between(k.number, { min: 0 }) };
54
+ const JSCAD_SolidDto = { mesh: k.required(k.opaque) };
55
+ const JSCAD_SphereCentersDto = { centers: k.required(k.list(k.point3)), radius: k.between(k.number, { min: 0 }), segments: k.between(k.number, { min: 4 }) };
56
+ const JSCAD_SphereDto = { center: k.point3, radius: k.between(k.number, { min: 0 }), segments: k.between(k.number, { min: 4 }) };
57
+ const JSCAD_SphereTextDto = { text: k.string, radius: k.between(k.number, { min: 0 }), segments: k.between(k.number, { min: 4 }), xOffset: k.number, yOffset: k.number, height: k.between(k.number, { min: 0 }), lineSpacing: k.number, letterSpacing: k.number, align: k.oneOf(["left", "center", "right"]), extrudeOffset: k.number };
58
+ const JSCAD_SquareDto = { center: k.point2, size: k.between(k.number, { min: 0 }) };
59
+ const JSCAD_StarDto = { center: k.point2, vertices: k.between(k.number, { min: 2 }), density: k.between(k.number, { min: 0 }), outerRadius: k.between(k.number, { min: 0, exclusiveMin: true }), innerRadius: k.between(k.number, { min: 0 }), startAngle: k.between(k.number, { min: 0 }) };
60
+ const JSCAD_TextDto = { text: k.string, segments: k.between(k.number, { min: 0 }), xOffset: k.number, yOffset: k.number, height: k.between(k.number, { min: 0 }), lineSpacing: k.number, letterSpacing: k.number, align: k.oneOf(["left", "center", "right"]), extrudeOffset: k.number };
61
+ const JSCAD_TorusDto = { center: k.point3, innerRadius: k.between(k.number, { min: 0, exclusiveMin: true }), outerRadius: k.between(k.number, { min: 0, exclusiveMin: true }), innerSegments: k.between(k.number, { min: 3 }), outerSegments: k.between(k.number, { min: 3 }), innerRotation: k.number, outerRotation: k.between(k.number, { min: 0, exclusiveMin: true }), startAngle: k.between(k.number, { min: 0 }) };
62
+ const JSCAD_TransformSolidDto = { mesh: k.required(k.opaque), transformation: k.required(k.opaque) };
63
+ const JSCAD_TransformSolidsDto = { meshes: k.required(k.list(k.opaque)), transformation: k.required(k.opaque) };
64
+ /**
65
+ * Every public operation of the JSCAD kernel by its dotted path, the inputs DTO it
66
+ * takes, and what each property of that DTO accepts. `resolveInputs` from the base package reads
67
+ * it to lay a caller's properties over that DTO's defaults before the kernel runs, and
68
+ * `validateInputs` to check what the call was given.
69
+ */
70
+ export const jscadDtoRegistry = {
71
+ "booleans.intersect": { dto: Inputs.JSCAD.BooleanObjectsDto, constraints: JSCAD_BooleanObjectsDto },
72
+ "booleans.intersectTwo": { dto: Inputs.JSCAD.BooleanTwoObjectsDto, constraints: JSCAD_BooleanTwoObjectsDto },
73
+ "booleans.minkowskiSum": { dto: Inputs.JSCAD.MinkowskiSumDto, constraints: JSCAD_MinkowskiSumDto },
74
+ "booleans.subtract": { dto: Inputs.JSCAD.BooleanObjectsDto, constraints: JSCAD_BooleanObjectsDto },
75
+ "booleans.subtractFrom": { dto: Inputs.JSCAD.BooleanObjectsFromDto, constraints: JSCAD_BooleanObjectsFromDto },
76
+ "booleans.subtractTwo": { dto: Inputs.JSCAD.BooleanTwoObjectsDto, constraints: JSCAD_BooleanTwoObjectsDto },
77
+ "booleans.union": { dto: Inputs.JSCAD.BooleanObjectsDto, constraints: JSCAD_BooleanObjectsDto },
78
+ "booleans.unionTwo": { dto: Inputs.JSCAD.BooleanTwoObjectsDto, constraints: JSCAD_BooleanTwoObjectsDto },
79
+ "colors.colorize": { dto: Inputs.JSCAD.ColorizeDto, constraints: JSCAD_ColorizeDto },
80
+ "downloadGeometry3MF": { dto: Inputs.JSCAD.DownloadGeometryDto, constraints: JSCAD_DownloadGeometryDto },
81
+ "downloadGeometryDxf": { dto: Inputs.JSCAD.DownloadGeometryDto, constraints: JSCAD_DownloadGeometryDto },
82
+ "downloadSolidsSTL": { dto: Inputs.JSCAD.DownloadSolidsDto, constraints: JSCAD_DownloadSolidsDto },
83
+ "downloadSolidSTL": { dto: Inputs.JSCAD.DownloadSolidDto, constraints: JSCAD_DownloadSolidDto },
84
+ "expansions.expand": { dto: Inputs.JSCAD.ExpandDto, constraints: JSCAD_ExpandDto },
85
+ "expansions.offset": { dto: Inputs.JSCAD.ExpansionDto, constraints: JSCAD_ExpansionDto },
86
+ "extrusions.extrudeLinear": { dto: Inputs.JSCAD.ExtrudeLinearDto, constraints: JSCAD_ExtrudeLinearDto },
87
+ "extrusions.extrudeRectangular": { dto: Inputs.JSCAD.ExtrudeRectangularDto, constraints: JSCAD_ExtrudeRectangularDto },
88
+ "extrusions.extrudeRectangularPoints": { dto: Inputs.JSCAD.ExtrudeRectangularPointsDto, constraints: JSCAD_ExtrudeRectangularPointsDto },
89
+ "extrusions.extrudeRotate": { dto: Inputs.JSCAD.ExtrudeRotateDto, constraints: JSCAD_ExtrudeRotateDto },
90
+ "hulls.hull": { dto: Inputs.JSCAD.HullDto, constraints: JSCAD_HullDto },
91
+ "hulls.hullChain": { dto: Inputs.JSCAD.HullDto, constraints: JSCAD_HullDto },
92
+ "hulls.isConvex": { dto: Inputs.JSCAD.SolidDto, constraints: JSCAD_SolidDto },
93
+ "path.appendArc": { dto: Inputs.JSCAD.PathAppendArcDto, constraints: JSCAD_PathAppendArcDto },
94
+ "path.appendPoints": { dto: Inputs.JSCAD.PathAppendPointsDto, constraints: JSCAD_PathAppendPointsDto },
95
+ "path.appendPolyline": { dto: Inputs.JSCAD.PathAppendPolylineDto, nested: { polyline: Inputs.JSCAD.PolylinePropertiesDto }, constraints: JSCAD_PathAppendPolylineDto },
96
+ "path.close": { dto: Inputs.JSCAD.PathDto, constraints: JSCAD_PathDto },
97
+ "path.createEmpty": {},
98
+ "path.createFromPoints": { dto: Inputs.JSCAD.PathFromPointsDto, constraints: JSCAD_PathFromPointsDto },
99
+ "path.createFromPolyline": { dto: Inputs.JSCAD.PathFromPolylineDto, nested: { polyline: Inputs.JSCAD.PolylinePropertiesDto }, constraints: JSCAD_PathFromPolylineDto },
100
+ "path.createPathsFromPoints": { dto: Inputs.JSCAD.PathsFromPointsDto, constraints: JSCAD_PathsFromPointsDto },
101
+ "polygon.circle": { dto: Inputs.JSCAD.CircleDto, constraints: JSCAD_CircleDto },
102
+ "polygon.createFromCurve": { dto: Inputs.JSCAD.CurveDto, constraints: JSCAD_CurveDto },
103
+ "polygon.createFromPath": { dto: Inputs.JSCAD.PathDto, constraints: JSCAD_PathDto },
104
+ "polygon.createFromPoints": { dto: Inputs.JSCAD.PointsDto, constraints: JSCAD_PointsDto },
105
+ "polygon.createFromPolyline": { dto: Inputs.JSCAD.PolylineDto, nested: { polyline: Inputs.JSCAD.PolylinePropertiesDto }, constraints: JSCAD_PolylineDto },
106
+ "polygon.ellipse": { dto: Inputs.JSCAD.EllipseDto, constraints: JSCAD_EllipseDto },
107
+ "polygon.rectangle": { dto: Inputs.JSCAD.RectangleDto, constraints: JSCAD_RectangleDto },
108
+ "polygon.roundedRectangle": { dto: Inputs.JSCAD.RoundedRectangleDto, constraints: JSCAD_RoundedRectangleDto },
109
+ "polygon.square": { dto: Inputs.JSCAD.SquareDto, constraints: JSCAD_SquareDto },
110
+ "polygon.star": { dto: Inputs.JSCAD.StarDto, constraints: JSCAD_StarDto },
111
+ "shapes.cube": { dto: Inputs.JSCAD.CubeDto, constraints: JSCAD_CubeDto },
112
+ "shapes.cubesOnCenterPoints": { dto: Inputs.JSCAD.CubeCentersDto, constraints: JSCAD_CubeCentersDto },
113
+ "shapes.cuboid": { dto: Inputs.JSCAD.CuboidDto, constraints: JSCAD_CuboidDto },
114
+ "shapes.cuboidsOnCenterPoints": { dto: Inputs.JSCAD.CuboidCentersDto, constraints: JSCAD_CuboidCentersDto },
115
+ "shapes.cylinder": { dto: Inputs.JSCAD.CylidnerDto, constraints: JSCAD_CylidnerDto },
116
+ "shapes.cylinderElliptic": { dto: Inputs.JSCAD.CylidnerEllipticDto, constraints: JSCAD_CylidnerEllipticDto },
117
+ "shapes.cylinderEllipticOnCenterPoints": { dto: Inputs.JSCAD.CylidnerCentersEllipticDto, constraints: JSCAD_CylidnerCentersEllipticDto },
118
+ "shapes.cylindersOnCenterPoints": { dto: Inputs.JSCAD.CylidnerCentersDto, constraints: JSCAD_CylidnerCentersDto },
119
+ "shapes.ellipsoid": { dto: Inputs.JSCAD.EllipsoidDto, constraints: JSCAD_EllipsoidDto },
120
+ "shapes.ellipsoidsOnCenterPoints": { dto: Inputs.JSCAD.EllipsoidCentersDto, constraints: JSCAD_EllipsoidCentersDto },
121
+ "shapes.fromPolygonPoints": { dto: Inputs.JSCAD.FromPolygonPoints, constraints: JSCAD_FromPolygonPoints },
122
+ "shapes.geodesicSphere": { dto: Inputs.JSCAD.GeodesicSphereDto, constraints: JSCAD_GeodesicSphereDto },
123
+ "shapes.geodesicSpheresOnCenterPoints": { dto: Inputs.JSCAD.GeodesicSphereCentersDto, constraints: JSCAD_GeodesicSphereCentersDto },
124
+ "shapes.roundedCuboid": { dto: Inputs.JSCAD.RoundedCuboidDto, constraints: JSCAD_RoundedCuboidDto },
125
+ "shapes.roundedCuboidsOnCenterPoints": { dto: Inputs.JSCAD.RoundedCuboidCentersDto, constraints: JSCAD_RoundedCuboidCentersDto },
126
+ "shapes.roundedCylinder": { dto: Inputs.JSCAD.RoundedCylidnerDto, constraints: JSCAD_RoundedCylidnerDto },
127
+ "shapes.roundedCylindersOnCenterPoints": { dto: Inputs.JSCAD.RoundedCylidnerCentersDto, constraints: JSCAD_RoundedCylidnerCentersDto },
128
+ "shapes.sphere": { dto: Inputs.JSCAD.SphereDto, constraints: JSCAD_SphereDto },
129
+ "shapes.spheresOnCenterPoints": { dto: Inputs.JSCAD.SphereCentersDto, constraints: JSCAD_SphereCentersDto },
130
+ "shapes.torus": { dto: Inputs.JSCAD.TorusDto, constraints: JSCAD_TorusDto },
131
+ "shapesToMeshes": { dto: Inputs.JSCAD.MeshesDto, constraints: JSCAD_MeshesDto },
132
+ "shapeToMesh": { dto: Inputs.JSCAD.MeshDto, constraints: JSCAD_MeshDto },
133
+ "text.createVectorText": { dto: Inputs.JSCAD.TextDto, constraints: JSCAD_TextDto },
134
+ "text.cylindricalText": { dto: Inputs.JSCAD.CylinderTextDto, constraints: JSCAD_CylinderTextDto },
135
+ "text.sphericalText": { dto: Inputs.JSCAD.SphereTextDto, constraints: JSCAD_SphereTextDto },
136
+ "toPolygonPoints": { dto: Inputs.JSCAD.MeshDto, constraints: JSCAD_MeshDto },
137
+ "transformSolid": { dto: Inputs.JSCAD.TransformSolidDto, constraints: JSCAD_TransformSolidDto },
138
+ "transformSolids": { dto: Inputs.JSCAD.TransformSolidsDto, constraints: JSCAD_TransformSolidsDto },
139
+ };