@cutting/cloudinary-blurhash 0.1.1 → 0.1.2

package/README.md

@@ -0,0 +1,50 @@
+# @cutting/cloudinary-blurhash
+
+Cloudinary BlurHash will generate a JSON file mappig your Cloudinary images, with their blurhash equivalent.
+
+e.g.
+
+```JSON
+[
+  {
+    "id": "image_hash.png",
+    "url": "https://res.cloudinary.com/ddospxsc8/image/upload/v11/image_hash.png",
+    "blurhash": "U25Y1#_4xT-;NO-=?a%MV?j[o#WB?EW9ItM{",
+    "width": 600,
+    "height": 404
+  },
+```
+
+## Usage
+
+### Declare the `CLOUDINARY_URL` environment variable that takes this format.
+
+```shell
+export CLOUDINARY_URL=cloudinary://<API_KEY>:<CLOUDINARY_API_SECRET>@<CLOUDINARY_CLOUD_NAME>
+```
+
+### Run
+
+```shell
+npx @cutting/cloudinary-blurhash
+```
+
+### Switches
+
+- `-f` or `--file`, the file name and path to the JSON output. Default is `<CWD>/blurhash_image_map.json`
+
+e.g.
+
+```shell
+npx @cutting/cloudinary-blurhash -f ./app/json/blurhash_image_map.json
+```
+
+This package creates a [bin script](https://docs.npmjs.com/cli/v10/configuring-npm/package-json#bin) that can be executed like this:
+
+```shell
+npx @cutting/cloudinary-blurhash
+```
+
+Your console should look something like this:
+
+![cloudinary-blurhash cli](https://res.cloudinary.com/ddospxsc8/image/upload/v1695819802/blurhash-cli_ueur9k.png)

package/bin/index.mjs

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import '../dist/esm/index.js';

package/dist/esm/generateBlurhashFile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generateBlurhashFile.d.ts","sourceRoot":"","sources":["../../src/generateBlurhashFile.ts"],"names":[],"mappings":"AAsCA,wBAAsB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CA2C1E"}
+{"version":3,"file":"generateBlurhashFile.d.ts","sourceRoot":"","sources":["../../src/generateBlurhashFile.ts"],"names":[],"mappings":"AA2BA,wBAAsB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAkD1E"}

package/dist/esm/index.js

@@ -1,2 +1,2 @@
-import{createCommand as e}from"commander";import{v2 as o}from"cloudinary";import r from"fs";import{config as s}from"dotenv";import{getPixels as t}from"@unpic/pixels";import{encode as i}from"blurhash";import n from"chalk";import c from"log-update";import l from"path";const{promises:{writeFile:a}}=r;s(),o.config({secure:!0}),console.log(o.config());const h=e("generate-blur-hash");h.description("generate low quality placeholder (LQIP) using blurhash").option("-f, --file <file>","the name of the the json file","./blurhash_image_map.json").parse(process.argv).action((async function({file:e}){try{!async function(e){const r=process.hrtime(),s=l.join(process.cwd(),e),h=[],g=(await o.search.expression("format=(NOT ico)").max_results(1e3).execute()).resources.map((({secure_url:e,width:o,height:r})=>({secure_url:e,width:o,height:r})));console.clear(),console.log(`About to process ${n.green(g.length)} images`);for(const e of g){const o=await t(e.secure_url),s=Uint8ClampedArray.from(o.data),l=i(s,o.width,o.height,4,4),a=e.secure_url.split("/");h.push({id:a.slice(-1)[0],url:e.secure_url,blurhash:l,width:e.width,height:e.height});const x=((w=process.hrtime(r))[0]+w[1]/1e9).toFixed(3);m=n.green.bold(`${d=h.length,b=g.length,(100*d/b).toFixed(2)}%`),p=n.green.bold(""+(g.length-h.length)),u=n.green.bold(`${h.length}`),f=n.green.bold(x),c(`\n${m} Processed.\n\n${p} images remaining to process\n\n${u} images processed ✅\n\nProcess started ${f}s ago`)}var m,p,u,f,d,b,w;console.log(n.blue(`writing results to ${s}`)),a(s,JSON.stringify(h))}(e)}catch(e){console.error(e),process.exit(1)}})).parse(process.argv);export{h as program};
+import{createCommand as e}from"commander";import{v2 as r}from"cloudinary";import o from"fs";import{getPixels as s}from"@unpic/pixels";import{encode as t}from"blurhash";import i from"chalk";import n from"log-update";import c from"path";const{promises:{writeFile:l}}=o,a=e("generate-blur-hash");a.description("generate low quality placeholder (LQIP) using blurhash").option("-f, --file <file>","the name of the the json file","./blurhash_image_map.json").parse(process.argv).action((async function({file:e}){try{!async function(e){try{const d=process.hrtime(),f=c.join(process.cwd(),e),b=[],w=(await r.search.expression("format=(NOT ico and NOT gif)").max_results(1e3).execute()).resources.map((({secure_url:e,width:r,height:o})=>({secure_url:e,width:r,height:o})));console.clear(),console.log(`About to process ${i.green(w.length)} images`);for(const e of w){const r=await s(e.secure_url),c=Uint8ClampedArray.from(r.data),l=t(c,r.width,r.height,4,4),f=e.secure_url.split("/");b.push({id:f.slice(-1)[0],url:e.secure_url,blurhash:l,width:e.width,height:e.height});const x=((u=process.hrtime(d))[0]+u[1]/1e9).toFixed(3);o=i.green.bold(`${g=b.length,m=w.length,(100*g/m).toFixed(2)}%`),a=i.green.bold(""+(w.length-b.length)),h=i.green.bold(`${b.length}`),p=i.green.bold(x),n(`\n${o} Processed.\n\n${a} images remaining to process\n\n${h} images processed ✅\n\nProcess started ${p}s ago`)}console.log(i.blue(`writing results to ${f}`)),l(f,JSON.stringify(b))}catch(e){console.error(e)}var o,a,h,p,g,m,u}(e)}catch(e){console.error(e),process.exit(1)}})).parse(process.argv);export{a as program};
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../../src/generateBlurhashFile.ts","../../src/index.ts"],"sourcesContent":["import { v2 } from 'cloudinary';\nimport fs from 'fs';\nimport { config } from 'dotenv';\nimport type { BlurHashImage, SearchResults } from './types';\nimport { getPixels } from '@unpic/pixels';\nimport { encode } from 'blurhash';\nimport chalk from 'chalk';\nimport logUpdate from 'log-update';\nimport path from 'path';\n\nconst {\n  promises: { writeFile },\n} = fs;\n\nconfig();\n\nv2.config({ secure: true });\n\n// v2.config({\n//   cloud_name: process.env.CLOUDINARY_CLOUD_NAME,\n//   api_key: process.env.CLOUDINARY_API_KEY,\n//   api_secret: process.env.CLOUDINARY_API_SECRET,\n// });\n\nconsole.log(v2.config());\n\nconst percentage = (partialValue: number, totalValue: number) => ((100 * partialValue) / totalValue).toFixed(2);\n\nconst parseHrtimeToSeconds = (hrtime: [number, number]) => {\n  const seconds = (hrtime[0] + hrtime[1] / 1e9).toFixed(3);\n  return seconds;\n};\n\nconst updateLogs = (a: unknown, b: unknown, c: unknown, d: unknown) =>\n  logUpdate(\n    `\\n${a} Processed.\\n\\n${b} images remaining to process\\n\\n${c} images processed ✅\\n\\nProcess started ${d}s ago`,\n  );\n\nexport async function generateBlurhashFile(fileName: string): Promise<void> {\n  const startTime = process.hrtime();\n  const outFile = path.join(process.cwd(), fileName);\n\n  const blurhashImages: BlurHashImage[] = [];\n\n  const results: SearchResults = await v2.search.expression('format=(NOT ico)').max_results(1000).execute();\n\n  const images = results.resources.map(({ secure_url, width, height }) => ({ secure_url, width, height }));\n\n  console.clear();\n  console.log(`About to process ${chalk.green(images.length)} images`);\n\n  for (const image of images) {\n    const imgData = await getPixels(image.secure_url);\n\n    const data = Uint8ClampedArray.from(imgData.data);\n\n    const blurhash = encode(data, imgData.width, imgData.height, 4, 4);\n\n    const urlPrts = image.secure_url.split('/');\n\n    blurhashImages.push({\n      id: urlPrts.slice(-1)[0],\n      url: image.secure_url,\n      blurhash,\n      width: image.width,\n      height: image.height,\n    });\n\n    const elapsedSeconds = parseHrtimeToSeconds(process.hrtime(startTime));\n\n    updateLogs(\n      chalk.green.bold(`${percentage(blurhashImages.length, images.length)}%`),\n      chalk.green.bold(`${images.length - blurhashImages.length}`),\n      chalk.green.bold(`${blurhashImages.length}`),\n      chalk.green.bold(elapsedSeconds),\n    );\n  }\n\n  console.log(chalk.blue(`writing results to ${outFile}`));\n\n  writeFile(outFile, JSON.stringify(blurhashImages));\n}\n","import { createCommand } from 'commander';\nimport { generateBlurhashFile } from './generateBlurhashFile';\n\nexport const program = createCommand('generate-blur-hash');\n\nprogram\n  .description('generate low quality placeholder (LQIP) using blurhash')\n  .option('-f, --file <file>', 'the name of the the json file', './blurhash_image_map.json')\n  .parse(process.argv)\n  .action(async function ({ file }: { file: string }) {\n    try {\n      generateBlurhashFile(file);\n    } catch (err) {\n      console.error(err);\n      process.exit(1);\n    }\n  })\n  .parse(process.argv);\n"],"names":["promises","writeFile","fs","config","v2","secure","console","log","program","createCommand","description","option","parse","process","argv","action","async","file","fileName","startTime","hrtime","outFile","path","join","cwd","blurhashImages","images","search","expression","max_results","execute","resources","map","secure_url","width","height","clear","chalk","green","length","image","imgData","getPixels","data","Uint8ClampedArray","from","blurhash","encode","urlPrts","split","push","id","slice","url","elapsedSeconds","toFixed","a","bold","partialValue","totalValue","b","c","d","logUpdate","blue","JSON","stringify","generateBlurhashFile","err","error","exit"],"mappings":"2QAUA,MACEA,UAAUC,UAAEA,IACVC,EAEJC,IAEAC,EAAGD,OAAO,CAAEE,QAAQ,IAQpBC,QAAQC,IAAIH,EAAGD,gBCrBFK,EAAUC,EAAc,sBAErCD,EACGE,YAAY,0DACZC,OAAO,oBAAqB,gCAAiC,6BAC7DC,MAAMC,QAAQC,MACdC,QAAOC,gBAAgBC,KAAEA,IACxB,KD4BGD,eAAoCE,GACzC,MAAMC,EAAYN,QAAQO,SACpBC,EAAUC,EAAKC,KAAKV,QAAQW,MAAON,GAEnCO,EAAkC,GAIlCC,SAF+BtB,EAAGuB,OAAOC,WAAW,oBAAoBC,YAAY,KAAMC,WAEzEC,UAAUC,KAAI,EAAGC,aAAYC,QAAOC,aAAc,CAAEF,aAAYC,QAAOC,aAE9F7B,QAAQ8B,QACR9B,QAAQC,IAAI,oBAAoB8B,EAAMC,MAAMZ,EAAOa,kBAEnD,IAAK,MAAMC,KAASd,EAAQ,CAC1B,MAAMe,QAAgBC,EAAUF,EAAMP,YAEhCU,EAAOC,kBAAkBC,KAAKJ,EAAQE,MAEtCG,EAAWC,EAAOJ,EAAMF,EAAQP,MAAOO,EAAQN,OAAQ,EAAG,GAE1Da,EAAUR,EAAMP,WAAWgB,MAAM,KAEvCxB,EAAeyB,KAAK,CAClBC,GAAIH,EAAQI,OAAO,GAAG,GACtBC,IAAKb,EAAMP,WACXa,WACAZ,MAAOM,EAAMN,MACbC,OAAQK,EAAML,SAGhB,MAAMmB,IAxCoBlC,EAwCkBP,QAAQO,OAAOD,IAvCrC,GAAKC,EAAO,GAAK,KAAKmC,QAAQ,GAIpCC,EAsCdnB,EAAMC,MAAMmB,KAAK,GA7CHC,EA6CiBjC,EAAec,OA7CVoB,EA6CkBjC,EAAOa,QA7CA,IAAMmB,EAAgBC,GAAYJ,QAAQ,OAO7EK,EAuC1BvB,EAAMC,MAAMmB,KAAK,IAAG/B,EAAOa,OAASd,EAAec,SAvCbsB,EAwCtCxB,EAAMC,MAAMmB,KAAK,GAAGhC,EAAec,UAxCeuB,EAyClDzB,EAAMC,MAAMmB,KAAKH,GAxCrBS,EACE,KAAKP,mBAAmBI,oCAAoCC,2CAA2CC,SAyCxG,CA3CgB,IAACN,EAAYI,EAAYC,EAAYC,EAPpCJ,EAAsBC,EAEZvC,EAkD5Bd,QAAQC,IAAI8B,EAAM2B,KAAK,sBAAsB3C,MAE7CpB,EAAUoB,EAAS4C,KAAKC,UAAUzC,GACpC,CCtEM0C,CAAqBlD,EACtB,CAAC,MAAOmD,GACP9D,QAAQ+D,MAAMD,GACdvD,QAAQyD,KAAK,EACd,CACH,IACC1D,MAAMC,QAAQC"}
+{"version":3,"file":"index.js","sources":["../../src/generateBlurhashFile.ts","../../src/index.ts"],"sourcesContent":["import { v2 } from 'cloudinary';\nimport fs from 'fs';\nimport type { BlurHashImage, SearchResults } from './types';\nimport { getPixels } from '@unpic/pixels';\nimport { encode } from 'blurhash';\nimport chalk from 'chalk';\nimport logUpdate from 'log-update';\nimport path from 'path';\n\nconst {\n  promises: { writeFile },\n} = fs;\n\n// console.log(v2.config());\n\nconst percentage = (partialValue: number, totalValue: number) => ((100 * partialValue) / totalValue).toFixed(2);\n\nconst parseHrtimeToSeconds = (hrtime: [number, number]) => {\n  const seconds = (hrtime[0] + hrtime[1] / 1e9).toFixed(3);\n  return seconds;\n};\n\nconst updateLogs = (a: unknown, b: unknown, c: unknown, d: unknown) =>\n  logUpdate(\n    `\\n${a} Processed.\\n\\n${b} images remaining to process\\n\\n${c} images processed ✅\\n\\nProcess started ${d}s ago`,\n  );\n\nexport async function generateBlurhashFile(fileName: string): Promise<void> {\n  try {\n    const startTime = process.hrtime();\n    const outFile = path.join(process.cwd(), fileName);\n\n    const blurhashImages: BlurHashImage[] = [];\n\n    const results: SearchResults = await v2.search\n      .expression('format=(NOT ico and NOT gif)')\n      .max_results(1000)\n      .execute();\n\n    const images = results.resources.map(({ secure_url, width, height }) => ({ secure_url, width, height }));\n\n    console.clear();\n    console.log(`About to process ${chalk.green(images.length)} images`);\n\n    for (const image of images) {\n      const imgData = await getPixels(image.secure_url);\n\n      const data = Uint8ClampedArray.from(imgData.data);\n\n      const blurhash = encode(data, imgData.width, imgData.height, 4, 4);\n\n      const urlParts = image.secure_url.split('/');\n\n      blurhashImages.push({\n        id: urlParts.slice(-1)[0],\n        url: image.secure_url,\n        blurhash,\n        width: image.width,\n        height: image.height,\n      });\n\n      const elapsedSeconds = parseHrtimeToSeconds(process.hrtime(startTime));\n\n      updateLogs(\n        chalk.green.bold(`${percentage(blurhashImages.length, images.length)}%`),\n        chalk.green.bold(`${images.length - blurhashImages.length}`),\n        chalk.green.bold(`${blurhashImages.length}`),\n        chalk.green.bold(elapsedSeconds),\n      );\n    }\n\n    console.log(chalk.blue(`writing results to ${outFile}`));\n\n    writeFile(outFile, JSON.stringify(blurhashImages));\n  } catch (err) {\n    console.error(err);\n  }\n}\n","import { createCommand } from 'commander';\nimport { generateBlurhashFile } from './generateBlurhashFile';\n\nexport const program = createCommand('generate-blur-hash');\n\nprogram\n  .description('generate low quality placeholder (LQIP) using blurhash')\n  .option('-f, --file <file>', 'the name of the the json file', './blurhash_image_map.json')\n  .parse(process.argv)\n  .action(async function ({ file }: { file: string }) {\n    try {\n      generateBlurhashFile(file);\n    } catch (err) {\n      console.error(err);\n      process.exit(1);\n    }\n  })\n  .parse(process.argv);\n"],"names":["promises","writeFile","fs","program","createCommand","description","option","parse","process","argv","action","async","file","fileName","startTime","hrtime","outFile","path","join","cwd","blurhashImages","images","v2","search","expression","max_results","execute","resources","map","secure_url","width","height","console","clear","log","chalk","green","length","image","imgData","getPixels","data","Uint8ClampedArray","from","blurhash","encode","urlParts","split","push","id","slice","url","elapsedSeconds","toFixed","a","bold","partialValue","totalValue","b","c","d","logUpdate","blue","JSON","stringify","err","error","generateBlurhashFile","exit"],"mappings":"2OASA,MACEA,UAAUC,UAAEA,IACVC,ECRSC,EAAUC,EAAc,sBAErCD,EACGE,YAAY,0DACZC,OAAO,oBAAqB,gCAAiC,6BAC7DC,MAAMC,QAAQC,MACdC,QAAOC,gBAAgBC,KAAEA,IACxB,KDiBGD,eAAoCE,GACzC,IACE,MAAMC,EAAYN,QAAQO,SACpBC,EAAUC,EAAKC,KAAKV,QAAQW,MAAON,GAEnCO,EAAkC,GAOlCC,SAL+BC,EAAGC,OACrCC,WAAW,gCACXC,YAAY,KACZC,WAEoBC,UAAUC,KAAI,EAAGC,aAAYC,QAAOC,aAAc,CAAEF,aAAYC,QAAOC,aAE9FC,QAAQC,QACRD,QAAQE,IAAI,oBAAoBC,EAAMC,MAAMf,EAAOgB,kBAEnD,IAAK,MAAMC,KAASjB,EAAQ,CAC1B,MAAMkB,QAAgBC,EAAUF,EAAMT,YAEhCY,EAAOC,kBAAkBC,KAAKJ,EAAQE,MAEtCG,EAAWC,EAAOJ,EAAMF,EAAQT,MAAOS,EAAQR,OAAQ,EAAG,GAE1De,EAAWR,EAAMT,WAAWkB,MAAM,KAExC3B,EAAe4B,KAAK,CAClBC,GAAIH,EAASI,OAAO,GAAG,GACvBC,IAAKb,EAAMT,WACXe,WACAd,MAAOQ,EAAMR,MACbC,OAAQO,EAAMP,SAGhB,MAAMqB,IA5CkBrC,EA4CoBP,QAAQO,OAAOD,IA3CvC,GAAKC,EAAO,GAAK,KAAKsC,QAAQ,GAIpCC,EA0CZnB,EAAMC,MAAMmB,KAAK,GAjDLC,EAiDmBpC,EAAeiB,OAjDZoB,EAiDoBpC,EAAOgB,QAjDF,IAAMmB,EAAgBC,GAAYJ,QAAQ,OAO7EK,EA2CxBvB,EAAMC,MAAMmB,KAAK,IAAGlC,EAAOgB,OAASjB,EAAeiB,SA3CfsB,EA4CpCxB,EAAMC,MAAMmB,KAAK,GAAGnC,EAAeiB,UA5CauB,EA6ChDzB,EAAMC,MAAMmB,KAAKH,GA5CvBS,EACE,KAAKP,mBAAmBI,oCAAoCC,2CAA2CC,SA6CtG,CAED5B,QAAQE,IAAIC,EAAM2B,KAAK,sBAAsB9C,MAE7Cf,EAAUe,EAAS+C,KAAKC,UAAU5C,GACnC,CAAC,MAAO6C,GACPjC,QAAQkC,MAAMD,EACf,CAtDgB,IAACX,EAAYI,EAAYC,EAAYC,EAPpCJ,EAAsBC,EAEZ1C,CA4D9B,CClEMoD,CAAqBvD,EACtB,CAAC,MAAOqD,GACPjC,QAAQkC,MAAMD,GACdzD,QAAQ4D,KAAK,EACd,CACH,IACC7D,MAAMC,QAAQC"}

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@cutting/cloudinary-blurhash",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Generate blurhash for each image and generate a file",
   "repository": {
     "type": "git",
     "url": "https://github.com/dagda1/cuttingedge.git"
   },
   "module": "dist/esm/index.js",
-  "bin": "./tools/bin/cutting.js",
+  "bin": "./bin/index.mjs",
   "type": "module",
   "sideEffects": false,
   "types": "dist/esm/index.d.ts",
@@ -18,7 +18,6 @@
     "blurhash": "^2.0.5",
     "chalk": "^5.3.0",
     "cloudinary": "^1.41.0",
-    "dotenv": "^16.3.1",
     "log-update": "^5.0.1"
   },
   "devDependencies": {