gerbers-renderer 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { renderGerbersZip } from './render/renderGerbersZip';
+export { createBoardViewer, type BoardViewerOptions } from './viewer/BoardViewer';
+export type { RenderResult } from './render/renderGerbersZip';
+export type { BoardViewer, BoardGeom, ViewerLayers } from './viewer/types';

package/dist/io/file-classifier.d.ts

@@ -0,0 +1,47 @@
+import { ZipEntry } from './unzip';
+export type LayerRole = "top_copper" | "bottom_copper" | "inner_copper" | "top_mask" | "bottom_mask" | "top_silk" | "bottom_silk" | "outline" | "mechanical" | "unknown";
+export interface LayerHint {
+    /** Exact or suffix match for filenames, for example "myboard-F_Cu.gbr" */
+    pattern: string;
+    role: LayerRole;
+}
+/**
+ * Optional hints that the caller can pass in to override or refine classification.
+ */
+export interface LayerHints {
+    hints: LayerHint[];
+}
+/**
+ * Normalized representation of a Gerber like file from the zip.
+ */
+export interface ClassifiedGerberFile {
+    name: string;
+    role: LayerRole;
+    rawEntry: ZipEntry;
+    /**
+     * Lazily read and normalized text content.
+     * This calls normalizeGerberText under the hood.
+     */
+    getText: () => Promise<string>;
+}
+/**
+ * Normalized representation of a drill file from the zip.
+ */
+export interface ClassifiedDrillFile {
+    name: string;
+    rawEntry: ZipEntry;
+    /**
+     * Lazily read and normalized text content.
+     * This calls normalizeDrillText under the hood.
+     */
+    getText: () => Promise<string>;
+}
+export interface ClassifiedFiles {
+    gerbers: ClassifiedGerberFile[];
+    drills: ClassifiedDrillFile[];
+    ignored: ZipEntry[];
+}
+/**
+ * Classify zip entries into Gerber layers, drill files, and ignored files.
+ */
+export declare function classifyFiles(entries: ZipEntry[], hints?: LayerHints): ClassifiedFiles;

package/dist/io/file-normalizer.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Normalize generic text file content coming from zip entries:
+ * - Strip UTF-8 BOM if present
+ * - Normalize line endings to "\n"
+ * - Trim leading and trailing blank lines
+ */
+export declare function normalizeTextContent(raw: string): string;
+/**
+ * Normalize Gerber specific content if needed.
+ * Currently just uses generic normalization, but this is the extension point
+ * for future format specific tweaks.
+ */
+export declare function normalizeGerberText(raw: string): string;
+/**
+ * Normalize Excellon drill file content if needed.
+ * Currently just uses generic normalization.
+ */
+export declare function normalizeDrillText(raw: string): string;

package/dist/io/unzip.d.ts

@@ -0,0 +1,15 @@
+/**
+ * A single entry inside the unzipped gerbers.zip
+ */
+export interface ZipEntry {
+    /** Normalized path style name, always forward slashes */
+    name: string;
+    /** Read entry as UTF-8 text */
+    text: () => Promise<string>;
+    /** Read entry as ArrayBuffer */
+    arrayBuffer: () => Promise<ArrayBuffer>;
+}
+/**
+ * Accepts a File, Blob, or ArrayBuffer and returns a list of ZipEntry helpers.
+ */
+export declare function unzipGerbersZip(input: File | Blob | ArrayBuffer): Promise<ZipEntry[]>;

package/dist/parse/drill-parser.d.ts

@@ -0,0 +1,22 @@
+import { DrillHole } from '../types/pcb-model';
+/**
+ * Parsed drill data for a single Excellon file.
+ * This will be fed into the geometry pipeline.
+ */
+export interface ParsedDrillData {
+    name: string;
+    holes: DrillHole[];
+}
+/**
+ * Very naive Excellon drill parser.
+ *
+ * This is intentionally simple and conservative:
+ * - It understands basic tool definitions like "T01C0.300"
+ * - It understands coordinate lines like "X012345Y067890"
+ * - It assumes units are already inches or mm as used in the file, and does
+ *   not attempt unit conversion or integer format decoding.
+ *
+ * For now, you can treat this as a stub and gradually swap in a robust parser
+ * if needed. At minimum, it gives you some real hole locations to play with.
+ */
+export declare function parseDrillFile(name: string, content: string): ParsedDrillData;

package/dist/parse/gerber-parser.d.ts

@@ -0,0 +1,51 @@
+import { Vec2 } from '../types/pcb-model';
+import { LayerRole } from '../io/file-classifier';
+/**
+ * Primitive types used by the geometry pipeline. These are what
+ * polygonizer.ts consumes.
+ */
+export interface GerberPrimitiveTrack {
+    start: Vec2;
+    end: Vec2;
+    width: number;
+}
+export interface GerberPrimitiveArc {
+    start: Vec2;
+    end: Vec2;
+    center: Vec2;
+    clockwise: boolean;
+    width: number;
+}
+export interface GerberPrimitiveFlash {
+    position: Vec2;
+    diameterMm: number;
+}
+export interface GerberPrimitiveRegion {
+    boundary: Vec2[];
+    holes: Vec2[][];
+}
+export interface GerberPrimitives {
+    tracks: GerberPrimitiveTrack[];
+    arcs: GerberPrimitiveArc[];
+    flashes: GerberPrimitiveFlash[];
+    regions: GerberPrimitiveRegion[];
+}
+export interface GerberPrimitiveFlash {
+    position: Vec2;
+    diameterMm: number;
+    shape: string;
+    widthMm?: number;
+    heightMm?: number;
+}
+/**
+ * Parse a Gerber file into drawing primitives.
+ *
+ * This is a practical, not spec complete parser:
+ * - Handles %FS, %MO, %AD for simple circular apertures (C)
+ * - Handles D01 (draw), D02 (move), D03 (flash)
+ * - Handles G36/G37 for filled regions with multiple contours
+ * - Ignores arcs (G02/G03) for now
+ *
+ * It is good enough to visualize traces and pads for many KiCad/JLC style Gerbers.
+ */
+export declare function parseGerberFile(name: string, content: string, _role: LayerRole | string): GerberPrimitives;

package/dist/render/layerClassify.d.ts

@@ -0,0 +1,11 @@
+export type Classified = Partial<{
+    top_copper: string;
+    bottom_copper: string;
+    top_mask: string;
+    bottom_mask: string;
+    top_silk: string;
+    bottom_silk: string;
+    drills: string;
+    outline: string;
+}>;
+export declare function classifyLayerNames(names: string[]): Classified;

package/dist/render/renderGerbersZip.d.ts

@@ -0,0 +1,7 @@
+import { BoardGeom, ViewerLayers } from '../viewer/types';
+export type RenderResult = {
+    boardGeom: BoardGeom;
+    layers: ViewerLayers;
+    revoke: () => void;
+};
+export declare function renderGerbersZip(file: File): Promise<RenderResult>;

package/dist/types/options.d.ts

@@ -0,0 +1,19 @@
+import { LayerHints } from '../io/file-classifier';
+export interface LoadFromZipOptions {
+    /**
+     * Board thickness in millimeters.
+     * Used when the geometry pipeline builds the 3D model.
+     */
+    boardThicknessMm?: number;
+    /**
+     * Optional hints to override layer role detection based on filenames.
+     */
+    layerHints?: LayerHints;
+}
+/**
+ * Options used when you eventually hook this into a 3D viewer.
+ * For now, only LoadFromZipOptions is used by the pipeline.
+ */
+export interface RenderFromZipOptions extends LoadFromZipOptions {
+    canvas?: HTMLCanvasElement;
+}

package/dist/types/pcb-model.d.ts

@@ -0,0 +1,32 @@
+export type PcbSide = "top" | "bottom";
+export type PcbLayerKind = "copper" | "soldermask" | "silkscreen" | "outline";
+export interface Vec2 {
+    x: number;
+    y: number;
+}
+export interface Polygon {
+    outer: Vec2[];
+    holes: Vec2[][];
+}
+export interface LayerGeometry {
+    name: string;
+    side: PcbSide | null;
+    kind: PcbLayerKind;
+    polygons: Polygon[];
+}
+export interface DrillHole {
+    x: number;
+    y: number;
+    diameter: number;
+    plated: boolean;
+}
+export interface PcbModelGeometry {
+    widthMm: number;
+    heightMm: number;
+    thicknessMm: number;
+    copperLayers: LayerGeometry[];
+    maskLayers: LayerGeometry[];
+    silkLayers: LayerGeometry[];
+    outline: LayerGeometry | null;
+    drills: DrillHole[];
+}

package/dist/viewer/BoardViewer.d.ts

@@ -0,0 +1,5 @@
+import { BoardViewer } from './types';
+export type BoardViewerOptions = {
+    onDownload?: () => void;
+};
+export declare function createBoardViewer(host: HTMLElement, opts?: BoardViewerOptions): BoardViewer;

package/dist/viewer/types.d.ts

@@ -0,0 +1,34 @@
+export type BoardGeom = {
+    board: {
+        width_in: number;
+        height_in: number;
+        mm_bounds: {
+            min_x_mm: number;
+            min_y_mm: number;
+            max_x_mm: number;
+            max_y_mm: number;
+        };
+    };
+};
+export type ViewerLayers = Partial<{
+    top_copper: string;
+    bottom_copper: string;
+    top_mask: string;
+    bottom_mask: string;
+    top_silk: string;
+    bottom_silk: string;
+    drills: string;
+    vias: string;
+    top_board_mask: string;
+    bottom_board_mask: string;
+}>;
+export type ViewerSideMode = "top" | "bottom";
+export type BoardViewer = {
+    setData: (data: {
+        boardGeom: BoardGeom;
+        layers: ViewerLayers;
+    }) => void;
+    setSideMode: (mode: ViewerSideMode) => void;
+    fit: () => void;
+    dispose: () => void;
+};

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "gerbers-renderer",
+  "version": "0.1.0",
+  "description": "A frontend-only Gerber viewer for rendering PCB Gerbers directly in the browser.",
+  "private": false,
+  "type": "module",
+  "main": "./dist/gerbers-renderer.umd.js",
+  "module": "./dist/gerbers-renderer.es.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/gerbers-renderer.es.js",
+      "require": "./dist/gerbers-renderer.umd.js"
+    }
+  },
+  "unpkg": "./dist/gerbers-renderer.umd.js",
+  "jsdelivr": "./dist/gerbers-renderer.umd.js",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build",
+    "preview": "vite preview"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/asappcb/gerbers-renderer.git"
+  },
+  "keywords": [
+    "pcb",
+    "gerber",
+    "excellon",
+    "viewer",
+    "renderer",
+    "frontend",
+    "browser",
+    "svg",
+    "electronics"
+  ],
+  "author": "",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/asappcb/gerbers-renderer/issues"
+  },
+  "homepage": "https://github.com/asappcb/gerbers-renderer#readme",
+  "dependencies": {
+    "jszip": "^3.10.1"
+  },
+  "devDependencies": {
+    "@types/jszip": "^3.4.0",
+    "@types/node": "^24.10.1",
+    "@types/three": "^0.181.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3",
+    "vite": "^7.2.7",
+    "vite-plugin-dts": "^4.5.4"
+  }
+}