@slithy/prim-interface 0.5.1 → 1.0.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { ShapeInterface, StepData, SerializedOutput } from '@slithy/prim-lib';
-export { Bbox, Circle, Ellipse, Glyph, Hexagon, NGonOptions, RGB, RectOptions, Rectangle, ReplayResult, SerializedOutput, ShapeInterface, Square, StepData, Triangle, makeNGon, makeRect, replayOutput, stepPerf } from '@slithy/prim-lib';
+export { Bbox, Circle, CircleOptions, Ellipse, EllipseOptions, Glyph, GlyphOptions, Hexagon, NGonOptions, RGB, RectOptions, Rectangle, ReplayResult, SerializedOutput, ShapeInterface, Square, StepData, Triangle, makeCircle, makeEllipse, makeGlyph, makeNGon, makeRect, replayOutput, stepPerf } from '@slithy/prim-lib';
 
 interface Config {
     steps: number;
@@ -51,14 +51,26 @@ interface SaveOptions {
     suffix?: string;
     filename?: string;
 }
+interface SaveRasterOptions extends SaveOptions {
+    format?: 'png' | 'jpeg';
+    quality?: number;
+}
+interface SaveRasterFromVectorOptions extends SaveOptions {
+    format?: 'png' | 'jpeg';
+    quality?: number;
+    background?: Background;
+}
+interface ShareFromVectorOptions extends SaveOptions {
+    background?: Background;
+}
 type Background = string | [png: string, jpeg: string];
-declare function saveRaster(canvas: HTMLCanvasElement, format?: 'png' | 'jpeg', quality?: number, options?: SaveOptions): void;
-declare function saveRasterFromVector(svgString: string, width: number, height: number, format?: 'png' | 'jpeg', quality?: number, options?: SaveOptions, background?: Background): Promise<void>;
+declare function saveRaster(canvas: HTMLCanvasElement, options?: SaveRasterOptions): void;
+declare function saveRasterFromVector(svgString: string, width: number, height: number, options?: SaveRasterFromVectorOptions): Promise<void>;
 declare function copyRasterFromVector(svgString: string, width: number, height: number): Promise<void>;
-declare function shareFromVector(svgString: string, width: number, height: number, options?: SaveOptions, background?: Background): Promise<void>;
+declare function shareFromVector(svgString: string, width: number, height: number, options?: ShareFromVectorOptions): Promise<void>;
 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>;
 
-export { type Background, type Config, type JobHandle, type RunCallbacks, type SaveOptions, type StepResult, copyRaster, copyRasterFromVector, copyVector, run, runWorker, saveRaster, saveRasterFromVector, saveVector, share, shareFromVector };
+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

@@ -15,7 +15,8 @@ function run(source, cfg, callbacks = {}) {
     computeCfg = { ...cfg, width: cfg.width, height: cfg.height };
     const pixelRatio = cfg.pixelRatio ?? 1;
     const viewCfg = { ...computeCfg, width: computeCfg.scale * computeCfg.width, height: computeCfg.scale * computeCfg.height };
-    const deviceViewCfg = { ...viewCfg, width: viewCfg.width * pixelRatio, height: viewCfg.height * pixelRatio };
+    const displayFill = computeCfg.outputFill ?? computeCfg.fill;
+    const deviceViewCfg = { ...viewCfg, width: viewCfg.width * pixelRatio, height: viewCfg.height * pixelRatio, fill: displayFill };
     const result = Canvas.empty(deviceViewCfg);
     result.ctx.scale(computeCfg.scale * pixelRatio, computeCfg.scale * pixelRatio);
     if (!(result.node instanceof HTMLCanvasElement)) throw new Error("[prim] Expected HTMLCanvasElement");
@@ -93,18 +94,20 @@ function runWorker(source, cfg, callbacks = {}) {
   worker.onmessage = (e) => {
     const msg = e.data;
     if (msg.type === "ready") {
-      const { width, height, scale, fill } = msg;
+      const { width, height, scale, fill, outputFill } = msg;
       const pixelRatio = cfg.pixelRatio ?? 1;
-      const computeCfg = { ...cfg, width, height, scale, fill };
+      const computeCfg = { ...cfg, width, height, scale, fill, outputFill };
       const viewCfg = {
         ...computeCfg,
         width: scale * width,
         height: scale * height
       };
+      const displayFill = outputFill ?? fill;
       const deviceViewCfg = {
         ...viewCfg,
         width: viewCfg.width * pixelRatio,
-        height: viewCfg.height * pixelRatio
+        height: viewCfg.height * pixelRatio,
+        fill: displayFill
       };
       result = Canvas2.empty(deviceViewCfg);
       const displayCanvas = result.node;
@@ -203,22 +206,26 @@ function svgToCanvas(svgString, width, height, background) {
     img.src = url;
   });
 }
-function saveRaster(canvas, format = "png", quality = 0.92, options) {
+function saveRaster(canvas, options) {
+  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 dataUrl = canvas.toDataURL(mimeType, quality);
   triggerDownload(dataUrl, buildFilename(ext, options));
 }
-async function saveRasterFromVector(svgString, width, height, format = "png", quality = 0.92, options, background) {
-  const canvas = await svgToCanvas(svgString, width, height, resolveBackground(background, format));
-  saveRaster(canvas, format, quality, options);
+async function saveRasterFromVector(svgString, width, height, options) {
+  const format = options?.format ?? "png";
+  const quality = options?.quality ?? 0.92;
+  const canvas = await svgToCanvas(svgString, width, height, resolveBackground(options?.background, format));
+  saveRaster(canvas, { format, quality, suffix: options?.suffix, filename: options?.filename });
 }
 async function copyRasterFromVector(svgString, width, height) {
   const canvas = await svgToCanvas(svgString, width, height);
   return copyRaster(canvas);
 }
-async function shareFromVector(svgString, width, height, options, background) {
-  const canvas = await svgToCanvas(svgString, width, height, resolveBackground(background, "png"));
+async function shareFromVector(svgString, width, height, options) {
+  const canvas = await svgToCanvas(svgString, width, height, resolveBackground(options?.background, "png"));
   return share(canvas, options);
 }
 function saveVector(svgString, options) {
@@ -251,7 +258,7 @@ async function share(canvas, options) {
 }
 
 // src/index.ts
-import { Triangle, Rectangle, Ellipse, Circle, Square, Hexagon, Glyph, stepPerf, replayOutput, makeNGon, makeRect } from "@slithy/prim-lib";
+import { Triangle, Rectangle, Ellipse, Circle, Square, Hexagon, Glyph, stepPerf, replayOutput, makeNGon, makeRect, makeCircle, makeEllipse, makeGlyph } from "@slithy/prim-lib";
 export {
   Circle,
   Ellipse,
@@ -263,6 +270,9 @@ export {
   copyRaster,
   copyRasterFromVector,
   copyVector,
+  makeCircle,
+  makeEllipse,
+  makeGlyph,
   makeNGon,
   makeRect,
   replayOutput,

package/dist/worker-entry.d.ts

@@ -1,4 +1,4 @@
-import { NGonOptions, RectOptions, PreCfg, StepData, SerializedOutput } from '@slithy/prim-lib';
+import { NGonOptions, RectOptions, CircleOptions, EllipseOptions, GlyphOptions, PreCfg, StepData, SerializedOutput } from '@slithy/prim-lib';
 
 type ShapeTypeSpec = string | {
     f: 'ngon';
@@ -6,6 +6,15 @@ type ShapeTypeSpec = string | {
 } | {
     f: 'rect';
     o: RectOptions;
+} | {
+    f: 'circle';
+    o: CircleOptions;
+} | {
+    f: 'ellipse';
+    o: EllipseOptions;
+} | {
+    f: 'glyph';
+    o: GlyphOptions;
 };
 type WorkerCfg = Omit<PreCfg, 'shapeTypes'> & {
     shapeTypeNames: ShapeTypeSpec[];
@@ -28,6 +37,7 @@ type WorkerOutbound = {
     height: number;
     scale: number;
     fill: string;
+    outputFill?: string;
 } | {
     type: 'step';
     stepData: StepData;

package/dist/worker-entry.js

@@ -1,5 +1,5 @@
 // src/worker-entry.ts
-import { Canvas, Optimizer, parseColor, makeNGon, makeRect } from "@slithy/prim-lib";
+import { Canvas, Optimizer, parseColor, makeNGon, makeRect, makeCircle, makeEllipse, makeGlyph } from "@slithy/prim-lib";
 import { Triangle, Rectangle, Ellipse, Circle, Square, Hexagon, Glyph } from "@slithy/prim-lib";
 var SHAPES = {
   Triangle,
@@ -26,6 +26,12 @@ self.onmessage = async (e) => {
               return makeNGon(spec.o);
             case "rect":
               return makeRect(spec.o);
+            case "circle":
+              return makeCircle(spec.o);
+            case "ellipse":
+              return makeEllipse(spec.o);
+            case "glyph":
+              return makeGlyph(spec.o);
           }
         }
         const ctor = SHAPES[spec];
@@ -59,7 +65,8 @@ self.onmessage = async (e) => {
         width: computeCfg.width,
         height: computeCfg.height,
         scale: computeCfg.scale,
-        fill: computeCfg.fill
+        fill: computeCfg.fill,
+        outputFill: computeCfg.outputFill
       });
       let stepCount = 0;
       const cc = computeCfg;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@slithy/prim-interface",
-  "version": "0.5.1",
+  "version": "1.0.0",
   "description": "Browser-facing API for primitive-based image reconstruction.",
   "type": "module",
   "exports": {
@@ -18,7 +18,7 @@
   ],
   "sideEffects": false,
   "dependencies": {
-    "@slithy/prim-lib": "0.5.1"
+    "@slithy/prim-lib": "0.6.0"
   },
   "devDependencies": {
     "@vitest/coverage-v8": "^4.1.2",
@@ -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",