splashy 5.1.47 → 6.0.0-1

package/README.md

@@ -22,7 +22,7 @@ $ npm install splashy --save
 ### From URL
 
 ```js
-(async () => {
+;(async () => {
   const splashy = require('splashy')
   const got = require('got')
 
@@ -38,7 +38,7 @@ $ npm install splashy --save
 ### From Buffer
 
 ```js
-(async () => {
+;(async () => {
   const splashy = require('splashy')
   const path = require('path')
   const fs = require('fs')
@@ -58,7 +58,7 @@ $ npm install splashy --save
 
 #### input
 
-*Required*<br>
+_Required_<br>
 Type: [ImageSource](https://github.com/akfish/node-vibrant#imagesource)
 
 The raw content for detecting the color information.
@@ -71,7 +71,9 @@ The raw content for detecting the color information.
 ## License
 
 **microlink-function** © [Microlink](https://microlink.io), released under the [MIT](https://github.com/microlink/microlink-function/blob/master/LICENSE.md) License.<br>
+
 Authored and maintained by [Kiko Beats](https://kikobeats.com) with help from [contributors](https://github.com/microlink/microlink-function/contributors).
 
-> [microlink.io](https://microlink.io) · GitHub [microlinkhq](https://github.com/microlinkhq) · X [@microlinkhq](https://x.com/microlinkhq)
+Special thanks to [Tim Carry](https://github.com/pixelastic) for writing the benchmark and [Lokesh Dhakar](https://github.com/lokesh) for the original code implementation.
 
+> [microlink.io](https://microlink.io) · GitHub [microlinkhq](https://github.com/microlinkhq) · X [@microlinkhq](https://x.com/microlinkhq)

package/package.json

@@ -2,7 +2,7 @@
   "name": "splashy",
   "description": "Given an image, extract predominant & palette colors",
   "homepage": "https://github.com/microlinkhq/splashy",
-  "version": "5.1.47",
+  "version": "6.0.0-1",
   "main": "src/index.js",
   "author": {
     "name": "Kiko Beats",
@@ -28,6 +28,7 @@
   "keywords": [
     "canvas",
     "color",
+    "colorthief",
     "colour",
     "dominant",
     "extract",
@@ -41,7 +42,9 @@
     "url"
   ],
   "dependencies": {
+    "@lokesh.dhakar/quantize": "~1.4.0",
     "debug-logfmt": "~1.2.3",
+    "ndarray": "~1.0.19",
     "node-addon-api": "~8.3.0",
     "node-gyp": "~11.0.0",
     "node-vibrant": "~3.2.1-alpha.1",
@@ -71,21 +74,13 @@
   "files": [
     "src"
   ],
-  "scripts": {
-    "clean": "rm -rf node_modules",
-    "contributors": "(npx git-authors-cli && npx finepack && git add package.json && git commit -m 'build: contributors' --no-verify) || true",
-    "dev": "nodemon --exec \"npm start\" -e \"js\"",
-    "lint": "standard-markdown README.md && standard",
-    "postrelease": "npm run release:tags && npm run release:github && (ci-publish || npm publish --access=public)",
-    "preinstall": "npx bin-version-check-cli magick \">=7\"",
-    "pretest": "npm run lint",
-    "release": "standard-version -a",
-    "release:github": "conventional-github-releaser -p angular",
-    "release:tags": "git push --follow-tags origin HEAD:master",
-    "start": "node index.js",
-    "test": "c8 ava"
-  },
   "license": "MIT",
+  "ava": {
+    "files": [
+      "test/**/*.js",
+      "!test/util.js"
+    ]
+  },
   "commitlint": {
     "extends": [
       "@commitlint/config-conventional"
@@ -111,5 +106,19 @@
   "simple-git-hooks": {
     "commit-msg": "npx commitlint --edit",
     "pre-commit": "npx nano-staged"
+  },
+  "scripts": {
+    "clean": "rm -rf node_modules",
+    "contributors": "(npx git-authors-cli && npx finepack && git add package.json && git commit -m 'build: contributors' --no-verify) || true",
+    "dev": "nodemon --exec \"npm start\" -e \"js\"",
+    "lint": "standard-markdown README.md && standard",
+    "postrelease": "npm run release:tags && npm run release:github && (ci-publish || npm publish --access=public)",
+    "preinstall": "npx bin-version-check-cli magick \">=7\"",
+    "pretest": "npm run lint",
+    "release": "standard-version -a",
+    "release:github": "conventional-github-releaser -p angular",
+    "release:tags": "git push --follow-tags origin HEAD:master",
+    "start": "node index.js",
+    "test": "c8 ava"
   }
-}
+}

package/src/index.js

@@ -1,34 +1,49 @@
 'use strict'
 
-const { serializeError } = require('serialize-error')
-const debug = require('debug-logfmt')('splashy')
-const createVibrant = require('./vibrant')
-
-const toPalette = swatch =>
-  Object.keys(swatch)
-    .reduce((acc, key) => {
-      const value = swatch[key]
-      if (value) {
-        acc.push({
-          popularity: value.getPopulation(),
-          hex: value.getHex()
-        })
-      }
-      return acc
-    }, [])
-    .sort((a, b) => a.popularity <= b.popularity)
-    .map(color => color.hex)
-
-module.exports = async input => {
-  let swatch
-
-  try {
-    const vibrant = createVibrant(input)
-    swatch = await vibrant.getPalette()
-  } catch (error) {
-    debug.error(serializeError(error))
-    swatch = {}
+const quantize = require('@lokesh.dhakar/quantize')
+const ndarray = require('ndarray')
+const sharp = require('sharp')
+
+async function getPixels ({ data, info }) {
+  return ndarray(
+    new Uint8Array(data.buffer, data.byteOffset, data.length),
+    [info.width, info.height, 4],
+    [4, (4 * info.width) | 0, 1],
+    0
+  )
+}
+
+function createPixelArray (pixels, pixelCount, quality = 10) {
+  const pixelArray = []
+  for (let i = 0, offset; i < pixelCount; i += quality) {
+    offset = i * 4
+    const r = pixels[offset]
+    const g = pixels[offset + 1]
+    const b = pixels[offset + 2]
+    const a = pixels[offset + 3]
+    const isOpaqueEnough = a >= 125
+    const isWhite = r > 250 && g > 250 && b > 250
+    if (isOpaqueEnough && !isWhite) pixelArray.push([r, g, b])
   }
 
-  return toPalette(swatch)
+  return pixelArray
+}
+
+const toHex = ([r, g, b]) => '#' + (b | (g << 8) | (r << 16) | (1 << 24)).toString(16).slice(1)
+
+module.exports = async function (buffer) {
+  const raw = await sharp(buffer)
+    // resizing the image before processing leads to more consistent (and much shorter) processing times.
+    // .resize(200, 200, { fit: 'inside', withoutEnlargement: true })
+    .ensureAlpha()
+    .raw()
+    .toBuffer({ resolveWithObject: true })
+
+  const imgData = await getPixels(raw)
+  const pixelCount = imgData.shape[0] * imgData.shape[1]
+  const pixelArray = createPixelArray(imgData.data, pixelCount)
+  const cmap = quantize(pixelArray, 10) // internal tuning
+  return cmap.palette().slice(0, 6).map(toHex)
 }
+
+module.exports.toHex = toHex

package/src/vibrant.js

@@ -1,62 +0,0 @@
-'use strict'
-
-const { ImageBase } = require('@vibrant/image')
-const Vibrant = require('node-vibrant')
-const sharp = require('sharp')
-
-class SharpImage extends ImageBase {
-  constructor () {
-    super(...arguments)
-    this._image = undefined
-  }
-
-  async load (image) {
-    if (typeof image === 'string' || image instanceof Buffer) {
-      const { data, info } = await sharp(image)
-        // resizing the image before processing leads to more consistent (and much shorter) processing times.
-        .resize(200, 200, { fit: 'inside', withoutEnlargement: true })
-        .ensureAlpha()
-        .raw()
-        .toBuffer({ resolveWithObject: true })
-
-      this._image = {
-        width: info.width,
-        height: info.height,
-        data
-      }
-
-      return this
-    } else {
-      return Promise.reject(
-        new Error('Cannot load image from HTMLImageElement in node environment')
-      )
-    }
-  }
-
-  clear () {}
-
-  update () {}
-
-  getWidth () {
-    return this._image.width
-  }
-
-  getHeight () {
-    return this._image.height
-  }
-
-  resize () {}
-
-  getPixelCount () {
-    const { width, height } = this._image
-    return width * height
-  }
-
-  getImageData () {
-    return this._image
-  }
-
-  remove () {}
-}
-
-module.exports = input => new Vibrant(input, { ImageClass: SharpImage })