@slithy/prim-interface 0.1.0

package/LICENSE

@@ -0,0 +1,91 @@
+# PolyForm Noncommercial License 1.0.0
+
+<https://polyformproject.org/licenses/noncommercial/1.0.0>
+
+Required Notice: Copyright Matthew Campagna
+
+## Acceptance
+
+In order to get any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the software to do everything you might do with the software that would otherwise infringe the licensor's copyright in it for any permitted purpose.  However, you may only distribute the software according to [Distribution License](#distribution-license) and make changes or new works based on the software according to [Changes and New Works License](#changes-and-new-works-license).
+
+## Distribution License
+
+The licensor grants you an additional copyright license to distribute copies of the software.  Your license to distribute covers distributing the software with changes and new works permitted by [Changes and New Works License](#changes-and-new-works-license).
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms or the URL for them above, as well as copies of any plain-text lines beginning with `Required Notice:` that the licensor provided with the software.  For example:
+
+> Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to make changes and new works based on the software for any permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that covers patent claims the licensor can license, or becomes able to license, that you would infringe by using the software.
+
+## Noncommercial Purposes
+
+Any noncommercial purpose is a permitted purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for the benefit of public knowledge, personal study, private entertainment, hobby projects, amateur pursuits, or religious observance, without any anticipated commercial application, is use for a permitted purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization, or government institution is use for a permitted purpose regardless of the source of funding or obligations resulting from the funding.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of your licenses to anyone else, or prevent the licensor from granting licenses to anyone else.  These terms do not imply any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have violated any of these terms, or done anything with the software not covered by your licenses, your licenses can nonetheless continue if you come into full compliance with these terms, and take practical steps to correct past violations, within 32 days of receiving notice.  Otherwise, all your licenses end immediately.
+
+## No Liability
+
+***As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.***
+
+## Definitions
+
+The **licensor** is the individual or entity offering these terms, and the **software** is the software the licensor makes available under these terms.
+
+**You** refers to the individual or entity agreeing to these terms.
+
+**Your company** is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization.  **Control** means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise.  Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the software under these terms.
+
+**Use** means anything you do with the software requiring one of your licenses.
+
+---
+
+## Third-party attributions
+
+This software is derived from the following MIT-licensed works:
+
+**primitive** by Michael Fogleman
+https://github.com/fogleman/primitive
+Copyright (c) 2016 Michael Fogleman — MIT License
+
+**primitive.js** by Ondřej Žára
+https://github.com/ondras/primitive.js
+Copyright (c) Ondřej Žára — MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notices and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,56 @@
+# @slithy/prim-interface
+
+Browser-facing API for `@slithy/prim-lib`. Consumed by `apps/prim-demo`.
+
+## What it does
+
+Wraps `prim-lib` in a simple `run()` API and provides save/copy/share helpers for exporting results.
+
+## Exports
+
+### `run(source, config, callbacks)`
+
+Starts a reconstruction job. Returns a `JobHandle` for stopping, pausing, and resuming.
+
+```ts
+const job = run(imageUrl, config, {
+  onStart(raster, svg) {},
+  onStep({ raster, svg, svgString, progress }) {},
+  onComplete() {},
+  onStop() {},
+});
+
+job.stop();
+job.pause();
+job.resume();
+```
+
+### Config
+
+```ts
+interface Config {
+  steps: number        // shapes in the final image
+  shapes: number       // candidate shapes evaluated per step
+  mutations: number    // random mutations tried per candidate
+  alpha: number        // shape opacity
+  mutateAlpha: boolean // whether opacity is mutated per candidate
+  computeSize: number  // internal render resolution (px)
+  viewSize: number     // display resolution (px)
+  shapeTypes: ShapeConstructor[]
+  fill: 'auto' | string
+}
+```
+
+`width`, `height`, and `scale` are set automatically by `run()` after loading the source image.
+
+### Exit helpers
+
+- **`saveRaster(canvas, format?, quality?)`** — downloads PNG or JPEG
+- **`saveVector(svgString)`** — downloads SVG
+- **`copyRaster(canvas)`** — copies PNG to clipboard
+- **`copyVector(svgString)`** — copies SVG markup to clipboard
+- **`share(canvas)`** — uses Web Share API if available
+
+### Re-exports from prim-lib
+
+`Triangle`, `Rectangle`, `Ellipse`, `Hexagon`, `Smiley`, `stepPerf`

package/dist/index.d.ts

@@ -0,0 +1,48 @@
+import { ShapeInterface } from '@slithy/prim-lib';
+export { Bbox, Ellipse, Hexagon, Rectangle, ShapeInterface, Smiley, Triangle, stepPerf } from '@slithy/prim-lib';
+
+interface Config {
+    steps: number;
+    shapes: number;
+    mutations: number;
+    alpha: number;
+    mutateAlpha: boolean;
+    computeSize: number;
+    viewSize: number;
+    shapeTypes: Array<new (w: number, h: number) => ShapeInterface>;
+    fill: 'auto' | string;
+    width?: number;
+    height?: number;
+    scale?: number;
+}
+interface StepResult {
+    raster: HTMLCanvasElement;
+    svg: SVGSVGElement;
+    svgString: string;
+    progress: {
+        current: number;
+        total: number;
+        similarity: number;
+    };
+}
+interface RunCallbacks {
+    onStart?: (raster: HTMLCanvasElement, svg: SVGSVGElement) => void;
+    onStep?: (result: StepResult) => void;
+    onComplete?: () => void;
+    onStop?: () => void;
+}
+interface JobHandle {
+    stop(): void;
+    pause(): void;
+    resume(): void;
+}
+
+declare function run(source: string | File, cfg: Config, callbacks?: RunCallbacks): JobHandle;
+
+declare function saveRaster(canvas: HTMLCanvasElement, format?: 'png' | 'jpeg', quality?: number): void;
+declare function saveVector(svgString: string): void;
+declare function copyVector(svgString: string): Promise<void>;
+declare function copyRaster(canvas: HTMLCanvasElement): Promise<void>;
+declare function share(canvas: HTMLCanvasElement): Promise<void>;
+
+export { type Config, type JobHandle, type RunCallbacks, type StepResult, copyRaster, copyVector, run, saveRaster, saveVector, share };

package/dist/index.js

@@ -0,0 +1,108 @@
+// src/run.ts
+import { Canvas, Optimizer } from "@slithy/prim-lib";
+function run(source, cfg, callbacks = {}) {
+  const url = source instanceof File ? URL.createObjectURL(source) : source;
+  let optimizer = null;
+  let stopped = false;
+  Canvas.original(url, cfg).then((original) => {
+    if (stopped) {
+      if (source instanceof File) URL.revokeObjectURL(url);
+      return;
+    }
+    if (source instanceof File) URL.revokeObjectURL(url);
+    const computeCfg = { ...cfg, width: cfg.width, height: cfg.height };
+    const viewCfg = { ...computeCfg, width: computeCfg.scale * computeCfg.width, height: computeCfg.scale * computeCfg.height };
+    const result = Canvas.empty(viewCfg);
+    result.ctx.scale(computeCfg.scale, computeCfg.scale);
+    const svg = Canvas.empty(computeCfg, true);
+    svg.setAttribute("width", String(viewCfg.width));
+    svg.setAttribute("height", String(viewCfg.height));
+    callbacks.onStart?.(result.node, svg);
+    const serializer = new XMLSerializer();
+    optimizer = new Optimizer(original, computeCfg);
+    let stepCount = 0;
+    optimizer.onStep = (step) => {
+      stepCount++;
+      if (step) {
+        result.drawStep(step);
+        svg.appendChild(step.toSVG());
+        callbacks.onStep?.({
+          raster: result.node,
+          svg,
+          svgString: serializer.serializeToString(svg),
+          progress: {
+            current: stepCount,
+            total: cfg.steps,
+            similarity: parseFloat((100 * (1 - step.distance)).toFixed(2))
+          }
+        });
+      }
+      if (stepCount >= cfg.steps) {
+        callbacks.onComplete?.();
+      }
+    };
+    optimizer.start();
+  }).catch((err) => {
+    console.error("[prim] run failed:", err);
+  });
+  return {
+    stop: () => {
+      stopped = true;
+      optimizer?.stop();
+      callbacks.onStop?.();
+    },
+    pause: () => optimizer?.pause(),
+    resume: () => optimizer?.resume()
+  };
+}
+
+// src/exit.ts
+function triggerDownload(url, filename) {
+  const a = document.createElement("a");
+  a.href = url;
+  a.download = filename;
+  a.click();
+}
+function saveRaster(canvas, format = "png", 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, `output.${ext}`);
+}
+function saveVector(svgString) {
+  const blob = new Blob([svgString], { type: "image/svg+xml" });
+  const url = URL.createObjectURL(blob);
+  triggerDownload(url, "output.svg");
+  URL.revokeObjectURL(url);
+}
+async function copyVector(svgString) {
+  await navigator.clipboard.writeText(svgString);
+}
+async function copyRaster(canvas) {
+  const blob = await new Promise((resolve, reject) => canvas.toBlob((b) => b ? resolve(b) : reject(new Error("toBlob failed"))));
+  await navigator.clipboard.write([new ClipboardItem({ "image/png": blob })]);
+}
+async function share(canvas) {
+  const blob = await new Promise((resolve, reject) => canvas.toBlob((b) => b ? resolve(b) : reject(new Error("toBlob failed"))));
+  const file = new File([blob], "output.png", { type: "image/png" });
+  if (navigator.canShare({ files: [file] })) {
+    await navigator.share({ files: [file] });
+  }
+}
+
+// src/index.ts
+import { Triangle, Rectangle, Ellipse, Hexagon, Smiley, stepPerf } from "@slithy/prim-lib";
+export {
+  Ellipse,
+  Hexagon,
+  Rectangle,
+  Smiley,
+  Triangle,
+  copyRaster,
+  copyVector,
+  run,
+  saveRaster,
+  saveVector,
+  share,
+  stepPerf
+};

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@slithy/prim-interface",
+  "version": "0.1.0",
+  "description": "Browser-facing API for primitive-based image reconstruction.",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "dependencies": {
+    "@slithy/prim-lib": "0.1.0"
+  },
+  "devDependencies": {
+    "@vitest/coverage-v8": "^4.1.0",
+    "jsdom": "^28",
+    "tsup": "^8",
+    "typescript": "^5",
+    "vitest": "^4",
+    "@slithy/tsconfig": "0.0.0",
+    "@slithy/eslint-config": "0.0.0"
+  },
+  "author": {
+    "name": "Matthew Campagna",
+    "url": "https://github.com/mjcampagna"
+  },
+  "license": "PolyForm-Noncommercial-1.0.0",
+  "keywords": [
+    "image",
+    "reconstruction",
+    "primitive",
+    "shapes",
+    "canvas"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mjcampagna/slithy.git",
+    "directory": "packages/prim-interface"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "rm -rf dist && tsup src/index.ts --format esm --dts",
+    "dev": "tsup src/index.ts --format esm --watch",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint .",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  }
+}