@cadit-app/maker-chips 0.2.1

package/src/main.ts

@@ -0,0 +1,36 @@
+/**
+ * @cadit-app/maker-chips
+ * 
+ * A customizable maker chip generator with patterns, center circles,
+ * and optional embedded QR codes.
+ */
+
+import { defineParams } from '@cadit-app/script-params';
+import { Manifold } from '@cadit-app/manifold-3d/manifoldCAD';
+import { assembleMakerchipShapes, AssemblyType } from './assembly';
+import { threeMfExporter } from './threeMfExport';
+import { makerChipParamsSchema, MakerChipParams } from './params';
+
+// Re-export for external use
+export { assembleMakerchipShapes } from './assembly';
+export { makerChipParamsSchema } from './params';
+export type { MakerChipParams } from './params';
+
+/**
+ * Main entry point using defineParams
+ */
+export default defineParams({
+  params: makerChipParamsSchema,
+  exporters: {
+    '3mf': threeMfExporter as any,
+  },
+  main: async (params): Promise<Manifold> => {
+    const assemblyType = params.assemblyType as AssemblyType;
+    
+    // Get all shapes for the assembly
+    const allShapes = await assembleMakerchipShapes(params as MakerChipParams, assemblyType);
+    
+    // Compose all shapes into a single manifold
+    return Manifold.compose(allShapes);
+  },
+});

package/src/params.ts

@@ -0,0 +1,110 @@
+/**
+ * Parameter schema for the Makerchip generator.
+ */
+
+import { svgDataUrls } from './embeddedSvgs';
+import qrCodeMaker from '@cadit-app/qr-code';
+import imageExtrudeMaker from '@cadit-app/image-extrude';
+import type { EmbeddedParamValue } from '@cadit-app/script-params';
+
+// Get the params from the imported makers
+const qrCodeParams = qrCodeMaker.params;
+const imageExtrudeParams = imageExtrudeMaker.params;
+
+// Override defaults for embedded use (smaller sizes to fit in chip)
+const qrCodeParamsWithOverrides = {
+  ...qrCodeParams,
+  size: { ...qrCodeParams.size, default: 18 },
+};
+
+const imageExtrudeParamsWithOverrides = {
+  ...imageExtrudeParams,
+  maxWidth: { ...imageExtrudeParams.maxWidth, default: 18 },
+};
+
+export const makerChipParamsSchema = {
+  radius: {
+    type: 'number',
+    label: 'Chip Radius (mm)',
+    default: 20,
+    min: 10,
+    max: 100,
+  },
+  height: {
+    type: 'number',
+    label: 'Extrusion Height (mm)',
+    default: 3,
+  },
+  roundingRadius: {
+    type: 'number',
+    label: "Round the chip's edges (mm)",
+    default: 1,
+    min: 0,
+  },
+  centerCircleRadius: {
+    type: 'number',
+    label: 'Center Circle Radius (mm)',
+    default: 14,
+  },
+  assemblyType: {
+    type: 'choice',
+    label: 'Assembly Type',
+    options: [
+      { value: 'flat', label: 'Flat (for preview/export)' },
+      { value: 'printable', label: 'Assembled (for 3D printing)' },
+    ],
+    default: 'flat',
+  },
+  markings: {
+    type: 'buttonGrid',
+    label: 'Pattern Style',
+    options: [
+      { value: 'makerChipV1', image: svgDataUrls.makerChipV1 },
+      { value: 'makerChipV2', image: svgDataUrls.makerChipV2 },
+      { value: 'makerChipV3', image: svgDataUrls.makerChipV3 },
+      { value: 'makerChipV4', image: svgDataUrls.makerChipV4 },
+      { value: 'makerChipV5', image: svgDataUrls.makerChipV5 },
+      { value: 'makerChipV6', image: svgDataUrls.makerChipV6 },
+      { value: 'makerChipV7', image: svgDataUrls.makerChipV7 },
+      { value: 'makerChipV8', image: svgDataUrls.makerChipV8 },
+      { value: 'makerChipV9', image: svgDataUrls.makerChipV9 },
+      { value: 'makerChipV10', image: svgDataUrls.makerChipV10 },
+      { value: 'makerChipV11', image: svgDataUrls.makerChipV11 },
+      { value: 'makerChipV12', image: svgDataUrls.makerChipV12 },
+      { value: 'makerChipV13', image: svgDataUrls.makerChipV13 },
+      { value: 'makerChipV14', image: svgDataUrls.makerChipV14 },
+      { value: 'makerChipV15', image: svgDataUrls.makerChipV15 },
+      { value: 'makerChipV16', image: svgDataUrls.makerChipV16 },
+      { value: 'makerChipV17', image: svgDataUrls.makerChipV17 },
+      { value: 'makerChipV18', image: svgDataUrls.makerChipV18 },
+      { value: 'makerChipV19', image: svgDataUrls.makerChipV19 },
+      { value: 'makerChipV20', image: svgDataUrls.makerChipV20 },
+    ],
+    default: 'makerChipV1',
+  },
+  qrCodeSettings: {
+    type: 'embedded',
+    label: 'QR Code (Optional)',
+    params: qrCodeParamsWithOverrides,
+    enabled: false,
+    showSettings: false,
+  },
+  imageExtrudeSettings: {
+    type: 'embedded',
+    label: 'Image Extrude (Optional)',
+    params: imageExtrudeParamsWithOverrides,
+    enabled: false,
+    showSettings: false,
+  },
+} as const;
+
+export type MakerChipParams = {
+  radius: number;
+  height: number;
+  roundingRadius: number;
+  centerCircleRadius: number;
+  assemblyType: 'flat' | 'printable';
+  markings: string;
+  qrCodeSettings: EmbeddedParamValue<typeof qrCodeParamsWithOverrides>;
+  imageExtrudeSettings: EmbeddedParamValue<typeof imageExtrudeParamsWithOverrides>;
+};

package/src/threeMfExport.ts

@@ -0,0 +1,123 @@
+/**
+ * 3MF Exporter for Makerchip.
+ * Exports the chip with separate parts for multi-color printing.
+ */
+
+// @ts-ignore - No type declarations available
+import type { Exporter, ExportResult } from '@cadit-app/script-params';
+import type { Manifold } from '@cadit-app/manifold-3d';
+// @ts-ignore - No type declarations available
+import { to3dmodel, fileForContentTypes, FileForRelThumbnail } from '@jscadui/3mf-export';
+import { strToU8, Zippable, zipSync } from 'fflate';
+import { assembleMakerchipShapes } from './assembly';
+import type { MakerChipParams } from './params';
+
+/**
+ * Export the Makerchip as a 3MF file.
+ * Always uses the "printable" assembly for proper multi-part export.
+ */
+export async function threeMfExport(params: MakerChipParams): Promise<ExportResult> {
+  // Always use the "printable" assembly for 3MF export
+  const shapes = await assembleMakerchipShapes(params, 'printable');
+
+  // Export each shape as a separate mesh
+  const meshes = shapes.map((shape, i) => {
+    const mesh = shape.getMesh();
+    return {
+      id: (i + 1).toString(),
+      vertices: mesh.vertProperties,
+      indices: mesh.triVerts,
+      name: `Makerchip-Part-${i + 1}`,
+    };
+  });
+
+  // Generate a single component, with all meshes as children, in order
+  const components = [
+    {
+      id: meshes.length + 1,
+      children: meshes.map((mesh) => ({ objectID: mesh.id })),
+      name: 'Makerchip-Assembly',
+    },
+  ];
+
+  // The main item should reference the components
+  const items = components.map((component) => ({
+    objectID: component.id,
+  }));
+
+  const header = {
+    unit: 'millimeter',
+    title: 'CADit Makerchip',
+    description: 'Makerchip 3MF export',
+    application: 'CADit',
+  };
+
+  const to3mf = {
+    meshes,
+    components,
+    items,
+    precision: 7,
+    header,
+  };
+
+  // Generate the 3MF XML model
+  const model = to3dmodel(to3mf as any);
+
+  // Package the 3MF file using fflate
+  const fileForRelThumbnail = new FileForRelThumbnail();
+  fileForRelThumbnail.add3dModel('3D/3dmodel.model');
+
+  const files: Zippable = {};
+  files['3D/3dmodel.model'] = strToU8(model);
+  files[fileForContentTypes.name] = strToU8(fileForContentTypes.content);
+  files[fileForRelThumbnail.name] = strToU8(fileForRelThumbnail.content);
+
+  // Set extruders for multi-color printing
+  const modelSettingsXml = generateModelSettingsConfig(meshes.length);
+  files['Metadata/model_settings.config'] = strToU8(modelSettingsXml);
+
+  const zipFile = zipSync(files);
+
+  return {
+    mimeType: 'model/3mf',
+    fileName: 'makerchip.3mf',
+    data: zipFile.buffer as ArrayBuffer,
+  };
+}
+
+/**
+ * Generate the model_settings.config XML for multi-extruder support.
+ */
+function generateModelSettingsConfig(partsCount: number): string {
+  // Assign extruder numbers 1-4, repeat 4 for any extra parts
+  const extruderForPart = (i: number) => (i < 4 ? i + 1 : 4);
+
+  let partsXml = '';
+  for (let i = 0; i < partsCount; i++) {
+    partsXml += `
+    <part id="${i + 1}" subtype="normal_part">
+      <metadata key="name" value="Makerchip-Assembly_${i + 1}"/>
+      <metadata key="extruder" value="${extruderForPart(i)}"/>
+    </part>`;
+  }
+
+  return `<?xml version="1.0" encoding="UTF-8"?>
+<config>
+  <object id="${partsCount + 1}">
+    <metadata key="name" value="Makerchip-Assembly"/>
+    <metadata key="extruder" value="1"/>
+    ${partsXml}
+  </object>
+</config>
+`;
+}
+
+/**
+ * 3MF Exporter for defineParams.
+ */
+export const threeMfExporter: Exporter<MakerChipParams> = {
+  name: '3MF',
+  label: 'Download 3MF',
+  description: 'Export the Makerchip as a 3MF file for multi-color 3D printing.',
+  export: threeMfExport,
+};

package/src/utils.ts

@@ -0,0 +1,32 @@
+/**
+ * Utility for parsing SVG content to CrossSection.
+ */
+
+import { svgToPolygons } from '@cadit-app/svg-sampler';
+import { embeddedSvgs } from './embeddedSvgs';
+import { CrossSection } from '@cadit-app/manifold-3d/manifoldCAD';
+
+/**
+ * Parse an SVG pattern name to a CrossSection
+ */
+export async function parseSvgToCrossSection(
+  shapeName: string,
+  maxError: number = 0.01
+): Promise<CrossSection> {
+  // Get the SVG content from embedded SVGs
+  const svgContent = embeddedSvgs[shapeName];
+  if (!svgContent) {
+    throw new Error(`Unknown shape: ${shapeName}. Available shapes: ${Object.keys(embeddedSvgs).join(', ')}`);
+  }
+
+  // Sample the SVG into polygons
+  const polygons = await svgToPolygons(svgContent, { maxError });
+
+  // Flip the Y-axis for SVG paths (SVG uses Y-down, but 3D modeling uses Y-up)
+  const flippedPolygons = polygons.map((polygon) => {
+    return polygon.points.map(([x, y]) => [x, -y]) as [number, number][];
+  });
+
+  // Create and return a cross-section from the sampled paths
+  return new CrossSection(flippedPolygons, 'EvenOdd').simplify(maxError);
+}

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "lib": ["ES2022"],
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "declaration": true,
+    "outDir": "./dist",
+    "rootDir": ".",
+    "resolveJsonModule": true,
+    "allowSyntheticDefaultImports": true,
+    "noEmit": true
+  },
+  "include": ["src/**/*", "cli.ts"],
+  "exclude": ["node_modules", "dist"]
+}