sweetcorn 0.0.1 → 0.1.0

package/dist/index.d.ts

@@ -1,7 +1,10 @@
 import type { Sharp } from 'sharp';
-import type { DitheringAlgorithm } from './types';
-export type { DitheringAlgorithm };
-interface SweetcornOptions {
-    algorithm: DitheringAlgorithm;
-}
-export default function sweetcorn(image: Sharp, { algorithm }: SweetcornOptions): Promise<Sharp>;
+import type { SweetcornOptions } from './types';
+export type { DitheringAlgorithm } from './types';
+/**
+ * Create a dithered image — turn smooth pixels into crunchy kernels! 🌽
+ * @param image A Sharp image instance, e.g. created using `sharp('my-file.png')`.
+ * @param options Options configuring Sweetcorn.
+ * @returns A new Sharp image instance.
+ */
+export default function sweetcorn(image: Sharp, options: SweetcornOptions): Promise<Sharp>;

package/dist/index.js

@@ -1,4 +1,5 @@
 import thresholdMaps from './threshold-maps.json' with { type: 'json' };
+;
 import diffusionKernels from './diffusion-kernels';
 let sharp;
 async function loadSharp() {
@@ -13,7 +14,14 @@ async function loadSharp() {
     sharpImport.cache(false);
     return sharpImport;
 }
-export default async function sweetcorn(image, { algorithm }) {
+/**
+ * Create a dithered image — turn smooth pixels into crunchy kernels! 🌽
+ * @param image A Sharp image instance, e.g. created using `sharp('my-file.png')`.
+ * @param options Options configuring Sweetcorn.
+ * @returns A new Sharp image instance.
+ */
+export default async function sweetcorn(image, options) {
+    const { algorithm } = options;
     if (!sharp)
         sharp = await loadSharp();
     // Convert image to greyscale before dithering.
@@ -21,8 +29,8 @@ export default async function sweetcorn(image, { algorithm }) {
     image.gamma(2.2, 1).greyscale();
     // Get raw pixel data for this image.
     const rawPixels = await image.raw().toBuffer({ resolveWithObject: true });
-    const thresholdMap = thresholdMaps[algorithm];
-    const diffusionKernel = diffusionKernels[algorithm];
+    const thresholdMap = options.thresholdMap || thresholdMaps[algorithm];
+    const diffusionKernel = options.diffusionKernel || diffusionKernels[algorithm];
     if (thresholdMap) {
         applyThresholdMap(rawPixels, thresholdMap);
     }

package/dist/types.d.ts

@@ -1,3 +1,39 @@
 import type diffusionKernels from './diffusion-kernels';
 import type thresholdMaps from './threshold-maps.json';
 export type DitheringAlgorithm = keyof typeof thresholdMaps | keyof typeof diffusionKernels | 'white-noise' | 'threshold';
+export interface SweetcornOptions {
+    /**
+     * The name of one of Sweetcorn’s built-in dithering algorithms to use.
+     *
+     * @see https://delucis.github.io/sweetcorn/algorithms/
+     *
+     * @example
+     * algorithm: 'floyd-steinberg'
+     */
+    algorithm?: DitheringAlgorithm | undefined;
+    /**
+     * A custom threshold map to use for ordered dithering.
+     *
+     * @see https://delucis.github.io/sweetcorn/guides/byo-algorithm/#defining-a-custom-threshold-map-for-sweetcorn
+     *
+     * @example
+     * thresholdMap: [
+     *   [0, 0.5],
+     *   [0.75, 0.25],
+     * ]
+     */
+    thresholdMap?: number[][] | undefined;
+    /**
+     * A custom diffusion kernel to use for error diffusion dithering.
+     *
+     * @see https://delucis.github.io/sweetcorn/guides/byo-algorithm/#defining-a-custom-diffusion-kernel-for-sweetcorn
+     *
+     * @example
+     * diffusionKernel: [
+     *   [0, 0, 0.2],
+     *   [0.1, 0.4, 0.1],
+     *   [0, 0.2, 0],
+     * ]
+     */
+    diffusionKernel?: number[][] | undefined;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sweetcorn",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "license": "MIT",
   "description": "JavaScript image dithering tools for Sharp",
   "keywords": [
@@ -29,7 +29,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "homepage": "https://github.com/delucis/sweetcorn",
+  "homepage": "https://delucis.github.io/sweetcorn/",
   "repository": {
     "type": "git",
     "url": "https://github.com/delucis/sweetcorn.git",