@slithy/prim-interface 1.0.3 → 1.0.4

package/README.md

@@ -105,7 +105,7 @@ interface StepResult {
 
 **`onComplete(serialized)`** — called when all steps finish. Receives a `SerializedOutput` — a compact, storage-ready representation of the full run that can be replayed via `replayOutput()`.
 
-**`onStop()`** — called when the job is stopped via `job.stop()`.
+**`onStop(serialized)`** — called when the job is stopped via `job.stop()`. Receives the `SerializedOutput` of shapes placed so far, or `null` if stopped before any shapes were placed.
 
 **`onError(message)`** — called if the job fails (e.g. image failed to load or decode). The job is considered stopped after this; no further callbacks will fire.
 
@@ -113,13 +113,13 @@ interface StepResult {
 
 Higher-level (rasterize SVG at save time for crisp output):
 
-- **`saveRasterFromVector(svgString, width, height, format?, quality?, options?, background?)`** — downloads PNG or JPEG rasterized from the SVG. `background` fills the canvas before drawing: JPEG defaults to `'white'` (prevents black transparent areas); PNG defaults to transparent. Pass a `Background` value to override.
+- **`saveRasterFromVector(svgString, width, height, options?)`** — downloads PNG or JPEG rasterized from the SVG. `background` fills the canvas before drawing: JPEG defaults to `'white'` (prevents black transparent areas); PNG defaults to transparent.
 - **`copyRasterFromVector(svgString, width, height)`** — copies a transparent PNG rasterized from the SVG to the clipboard
 - **`shareFromVector(svgString, width, height, options?)`** — shares a transparent PNG rasterized from the SVG via the Web Share API
 
 Lower-level (operate directly on a canvas or SVG string):
 
-- **`saveRaster(canvas, format?, quality?, options?)`** — downloads PNG or JPEG from a canvas
+- **`saveRaster(canvas, options?)`** — downloads PNG or JPEG from a canvas
 - **`saveVector(svgString, options?)`** — downloads SVG
 - **`copyRaster(canvas)`** — copies PNG to clipboard
 - **`copyVector(svgString)`** — copies SVG markup to clipboard
@@ -134,7 +134,13 @@ interface SaveOptions {
 }
 ```
 
-Example: `saveRaster(canvas, 'png', 0.92, { filename: 'mountains', suffix: 'v2' })` → `mountains--v2.png`
+**`SaveRasterOptions`** extends `SaveOptions` with `format?: 'png' | 'jpeg'` and `quality?: number`.
+
+**`SaveRasterFromVectorOptions`** extends `SaveOptions` with `format?`, `quality?`, and `background?: Background`.
+
+**`ShareFromVectorOptions`** extends `SaveOptions` with `background?: Background`.
+
+Example: `saveRaster(canvas, { format: 'png', quality: 0.92, filename: 'mountains', suffix: 'v2' })` → `mountains--v2.png`
 
 ### `replayOutput(data: SerializedOutput): ReplayResult`
 
@@ -148,13 +154,13 @@ const { raster, svg, svgString } = replayOutput(serializedData);
 
 **Shapes:** `Triangle`, `Rectangle`, `Ellipse`, `Circle`, `Square`, `Hexagon`, `Glyph`
 
-**Factories:** `makeNGon`, `makeRect`
+**Factories:** `makeNGon`, `makeRect`, `makeCircle`, `makeEllipse`, `makeGlyph`
 
-**Factory option types:** `NGonOptions`, `RectOptions`
+**Factory option types:** `NGonOptions`, `RectOptions`, `CircleOptions`, `EllipseOptions`, `GlyphOptions`
 
 **Functions:** `stepPerf`, `replayOutput`
 
-**Types:** `RGB`, `SerializedOutput`, `StepData`, `ReplayResult`, `ShapeInterface`, `Bbox`, `Background`
+**Types:** `RGB`, `SerializedOutput`, `StepData`, `ReplayResult`, `ShapeInterface`, `Bbox`, `Background`, `SaveRasterOptions`, `SaveRasterFromVectorOptions`, `ShareFromVectorOptions`
 
 `Background` controls the canvas fill for `saveRasterFromVector`:
 

package/dist/index.d.ts

@@ -62,6 +62,8 @@ interface SaveRasterFromVectorOptions extends SaveOptions {
 }
 interface ShareFromVectorOptions extends SaveOptions {
     background?: Background;
+    format?: 'png' | 'jpeg';
+    quality?: number;
 }
 type Background = string | [png: string, jpeg: string];
 declare function saveRaster(canvas: HTMLCanvasElement, options?: SaveRasterOptions): void;
@@ -71,6 +73,6 @@ declare function shareFromVector(svgString: string, width: number, height: numbe
 declare function saveVector(svgString: string, options?: SaveOptions): void;
 declare function copyVector(svgString: string): Promise<void>;
 declare function copyRaster(canvas: HTMLCanvasElement): Promise<void>;
-declare function share(canvas: HTMLCanvasElement, options?: SaveOptions): Promise<void>;
+declare function share(canvas: HTMLCanvasElement, options?: SaveRasterOptions): Promise<void>;
 
 export { type Background, type Config, type JobHandle, type RunCallbacks, type SaveOptions, type SaveRasterFromVectorOptions, type SaveRasterOptions, type ShareFromVectorOptions, type StepResult, copyRaster, copyRasterFromVector, copyVector, run, runWorker, saveRaster, saveRasterFromVector, saveVector, share, shareFromVector };

package/dist/index.js

@@ -225,7 +225,8 @@ async function copyRasterFromVector(svgString, width, height) {
   return copyRaster(canvas);
 }
 async function shareFromVector(svgString, width, height, options) {
-  const canvas = await svgToCanvas(svgString, width, height, resolveBackground(options?.background, "png"));
+  const format = options?.format ?? "png";
+  const canvas = await svgToCanvas(svgString, width, height, resolveBackground(options?.background, format));
   return share(canvas, options);
 }
 function saveVector(svgString, options) {
@@ -250,8 +251,12 @@ async function copyRaster(canvas) {
   await navigator.clipboard.write([new ClipboardItem({ "image/png": blob })]);
 }
 async function share(canvas, options) {
-  const blob = await new Promise((resolve, reject) => canvas.toBlob((b) => b ? resolve(b) : reject(new Error("toBlob failed"))));
-  const file = new File([blob], buildFilename("png", options), { type: "image/png" });
+  const format = options?.format ?? "png";
+  const quality = options?.quality ?? 0.92;
+  const mimeType = format === "jpeg" ? "image/jpeg" : "image/png";
+  const ext = format === "jpeg" ? "jpg" : "png";
+  const blob = await new Promise((resolve, reject) => canvas.toBlob((b) => b ? resolve(b) : reject(new Error("toBlob failed")), mimeType, quality));
+  const file = new File([blob], buildFilename(ext, options), { type: mimeType });
   if (navigator.canShare({ files: [file] })) {
     await navigator.share({ files: [file] });
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@slithy/prim-interface",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Browser-facing API for primitive-based image reconstruction.",
   "type": "module",
   "exports": {
@@ -26,8 +26,8 @@
     "tsup": "^8",
     "typescript": "^5",
     "vitest": "^4.1.2",
-    "@slithy/eslint-config": "0.0.0",
-    "@slithy/tsconfig": "0.0.0"
+    "@slithy/tsconfig": "0.0.0",
+    "@slithy/eslint-config": "0.0.0"
   },
   "author": {
     "name": "Matthew Campagna",