@slithy/prim-lib 0.8.0 → 0.8.1

package/README.md

@@ -2,6 +2,15 @@
 
 Core engine for primitive-based image reconstruction. Consumed by `@slithy/prim-interface`.
 
+## License
+
+This package is dual-licensed.
+
+- Public use is licensed under `PolyForm-Noncommercial-1.0.0` in [LICENSE](./LICENSE).
+- Separate commercial use rights, if any, are granted only by a separate written commercial license. The current repo-tracked commercial grant is in [LICENSE-COMMERCIAL.md](./LICENSE-COMMERCIAL.md).
+
+This package also includes upstream MIT attributions for `primitive` and `primitive.js` in its `LICENSE` file.
+
 ## What it does
 
 Reconstructs an image by iteratively placing geometric shapes. Each step evaluates candidate shapes, mutates them, picks the one that most reduces the difference from the target, and draws it onto the working canvas.
@@ -24,10 +33,13 @@ Fixed shapes (class constructors, pass directly in `shapeTypes`):
 Configurable shapes (factory functions that return a constructor):
 
 - **`makeNGon(opts)`** — N-sided polygon; supports regular and irregular modes
-- **`makeRect(opts)`** — axis-aligned or rotatable rectangle with independent width/height control
+- **`makeRect(opts?)`** — axis-aligned or rotatable rectangle with independent width/height control
+- **`makeCircle(opts?)`** — circle with configurable size range and pixel-area constraints
+- **`makeEllipse(opts?)`** — ellipse with independent rx/ry ranges and optional aspect ratio lock
+- **`makeGlyph(opts?)`** — Unicode character shape; measures glyph bounds at render time and serializes as SVG `<text>`
 
 ```ts
-shapeTypes: [Triangle, makeNGon({ sides: 6, regular: true }), makeRect({ aspectRatio: 1.78 })]
+shapeTypes: [Triangle, makeNGon({ sides: 6, regular: true }), makeCircle({ sizeRange: [5, 20] })]
 ```
 
 ### Factory options
@@ -46,6 +58,14 @@ interface NGonOptions {
   sizeRange?: [number, number] // vertex radius range in compute-space px (default: [1, 20])
                                // regular: radius from center; irregular: scatter radius from first point
   mutationScale?: number      // max mutation step size in px (default: 20)
+  // pixel-area constraints (see Pixel-area constraints)
+  tonalRange?: [number, number]
+  invertTonal?: boolean
+  saturationRange?: [number, number]
+  invertSaturation?: boolean
+  hueCenter?: number
+  hueTolerance?: number
+  invertHue?: boolean
 }
 ```
 
@@ -60,9 +80,91 @@ interface RectOptions {
                                   // e.g. 1.78 for 16:9, 1.33 for 4:3, 1.0 for square
   rotatable?: boolean             // random rotation per instance (default: false)
   mutationScale?: number          // max mutation step size in px (default: 20)
+  // pixel-area constraints (see Pixel-area constraints)
+  tonalRange?: [number, number]
+  invertTonal?: boolean
+  saturationRange?: [number, number]
+  invertSaturation?: boolean
+  hueCenter?: number
+  hueTolerance?: number
+  invertHue?: boolean
+}
+```
+
+**`CircleOptions`**
+
+```ts
+interface CircleOptions {
+  sizeRange?: [number, number]    // radius range in compute-space px (default: [1, 20])
+  mutationScale?: number          // max mutation step size in px (default: 20)
+  // pixel-area constraints (see Pixel-area constraints)
+  tonalRange?: [number, number]
+  invertTonal?: boolean
+  saturationRange?: [number, number]
+  invertSaturation?: boolean
+  hueCenter?: number
+  hueTolerance?: number
+  invertHue?: boolean
 }
 ```
 
+**`EllipseOptions`**
+
+```ts
+interface EllipseOptions {
+  rxRange?: [number, number]      // x-radius range in compute-space px (default: [1, 20])
+  ryRange?: [number, number]      // y-radius range in compute-space px (default: [1, 20])
+                                  // ignored when aspectRatio is set
+  aspectRatio?: number            // rx ÷ ry; locks proportions, derives ry from rx
+  mutationScale?: number          // max mutation step size in px (default: 20)
+  // pixel-area constraints (see Pixel-area constraints)
+  tonalRange?: [number, number]
+  invertTonal?: boolean
+  saturationRange?: [number, number]
+  invertSaturation?: boolean
+  hueCenter?: number
+  hueTolerance?: number
+  invertHue?: boolean
+}
+```
+
+**`GlyphOptions`**
+
+```ts
+interface GlyphOptions {
+  char?: string                   // Unicode character (default: '☺')
+  fontFamily?: string             // CSS font-family string (default: 'sans-serif')
+  sizeRange?: [number, number]    // font-size range in compute-space px (default: [10, 30])
+  mutationScale?: number          // max mutation step size in px (default: 20)
+  // pixel-area constraints (see Pixel-area constraints)
+  tonalRange?: [number, number]
+  invertTonal?: boolean
+  saturationRange?: [number, number]
+  invertSaturation?: boolean
+  hueCenter?: number
+  hueTolerance?: number
+  invertHue?: boolean
+}
+```
+
+### Pixel-area constraints
+
+All factory shapes (`makeNGon`, `makeRect`, `makeCircle`, `makeEllipse`, `makeGlyph`) accept optional pixel-area constraint fields. Before rasterizing, the optimizer samples the pixels the shape would cover in the target image. If the area fails any active check, the shape is discarded without consuming the step budget. Shapes placed entirely outside the image bounds skip all checks.
+
+**`tonalRange: [min, max]`** — BT.601 luma (0–255). Discard if the covered area's average luminance falls outside `[min, max]`. Set `invertTonal: true` to keep shapes *outside* the range instead.
+
+**`saturationRange: [min, max]`** — HSL saturation (0–100). Discard if average saturation falls outside `[min, max]`. Set `invertSaturation: true` to invert.
+
+**`hueCenter` / `hueTolerance`** — center hue (0–360°) and allowed angular deviation in degrees. Discard if the covered area's average hue differs from `hueCenter` by more than `hueTolerance`. Set `invertHue: true` to invert. Both fields must be set together to activate the hue check.
+
+```ts
+// circles only in bright areas; glyphs only in desaturated areas
+shapeTypes: [
+  makeCircle({ sizeRange: [5, 20], tonalRange: [180, 255] }),
+  makeGlyph({ char: '·', saturationRange: [0, 20] }),
+]
+```
+
 ### Types
 
 **`Cfg`** — runtime config (all fields required):
@@ -167,4 +269,4 @@ interface ReplayResult {
 - When `shapeWeights` is provided (same length as `shapeTypes`), `Optimizer` builds a step plan at construction time: each shape type is allocated an exact number of slots proportional to its weight (using largest-remainder rounding), then the plan is Fisher-Yates shuffled. This guarantees the final shape distribution matches the weights, rather than just biasing random selection
 - `PreCfg` exists to bridge the gap between call time (dimensions unknown) and runtime (dimensions set by `Canvas.original()` or `Canvas.fromBitmap()`)
 - `Canvas.svgRoot()` is a static helper shared by `Canvas.empty()` and `replayOutput()` to create the SVG root with clip path and background fill; it uses DOM APIs and is main-thread only
-- Factory shapes (`makeNGon`, `makeRect`) capture their options in a closure and return an inner class. The class carries a static `_shapeSpec` property (`{ f: string, o: opts }`) used by `runWorker` to serialize and reconstruct the factory call inside the worker
+- Factory shapes (`makeNGon`, `makeRect`, `makeCircle`, `makeEllipse`, `makeGlyph`) capture their options in a closure and return an inner class. The class carries a static `_shapeSpec` property (`{ f: string, o: opts }`) used by `runWorker` to serialize and reconstruct the factory call inside the worker

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@slithy/prim-lib",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "description": "Core engine for primitive-based image reconstruction.",
   "type": "module",
   "exports": {
@@ -13,24 +13,14 @@
     "dist"
   ],
   "sideEffects": false,
-  "scripts": {
-    "clean": "rm -rf dist",
-    "prepack": "rm -rf dist && tsup src/index.ts --format esm --dts --keep-names",
-    "build": "rm -rf dist && tsup src/index.ts --format esm --dts --keep-names",
-    "dev": "tsup src/index.ts --format esm --watch --keep-names",
-    "typecheck": "tsc --noEmit",
-    "lint": "eslint .",
-    "test": "vitest run",
-    "test:watch": "vitest"
-  },
   "devDependencies": {
-    "@slithy/eslint-config": "workspace:*",
-    "@slithy/tsconfig": "workspace:*",
-    "@vitest/coverage-v8": "^4.1.2",
-    "jsdom": "^29.0.1",
+    "@vitest/coverage-v8": "^4.1.7",
+    "jsdom": "^29.1.1",
     "tsup": "^8",
     "typescript": "^5",
-    "vitest": "^4.1.2"
+    "vitest": "^4.1.7",
+    "@slithy/eslint-config": "0.0.0",
+    "@slithy/tsconfig": "0.0.0"
   },
   "author": {
     "name": "Matthew Campagna",
@@ -51,5 +41,14 @@
   },
   "publishConfig": {
     "access": "public"
+  },
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "rm -rf dist && tsup src/index.ts --format esm --dts --keep-names",
+    "dev": "tsup src/index.ts --format esm --watch --keep-names",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint .",
+    "test": "vitest run",
+    "test:watch": "vitest"
   }
-}
+}