Add option to store IPTC metadata

.changeset/long-coats-hear.md

@@ -0,0 +1,7 @@
+---
+'@tidaltheory/lens': minor
+---
+
+Add option to store IPTC metadata
+
+Only stores `object_name` (as `title`) and `caption` currently.

package.json

@@ -39,19 +39,24 @@
     "setup": "zazen configure"
   },
   "lint-staged": {
-    "*.{js,ts}": "eslint --fix",
+    "*.{js,ts}": [
+      "eslint --fix",
+      "prettier --write"
+    ],
     "package.json": "prettier --write"
   },
   "dependencies": {
+    "exif-reader": "1.0.3",
     "globby": "13.1.2",
     "is-plain-object": "5.0.0",
-    "lowdb": "3.0.0",
+    "lowdb": "5.0.3",
     "multimatch": "6.0.0",
     "node-vibrant": "3.2.1-alpha.1",
     "ora": "6.1.2",
     "pkg-conf": "4.0.0",
     "sade": "1.8.1",
-    "sharp": "0.30.7"
+    "sharp": "0.31.1",
+    "ts-node-iptc": "1.0.11"
   },
   "devDependencies": {
     "@changesets/changelog-github": "0.4.7",

src/cli.ts

@@ -4,13 +4,15 @@ import path, { parse } from 'node:path'
 import process from 'node:process'
 
 import { globby } from 'globby'
-import { JSONFile, Low } from 'lowdb'
+import { Low } from 'lowdb'
+import { JSONFile } from 'lowdb/node'
 import ora, { oraPromise } from 'ora'
 import sade from 'sade'
 import sharp from 'sharp'
+import { IptcParser } from 'ts-node-iptc'
 import { PackageJson } from 'type-fest'
 
-import { ImageRecord, ImageThumbnails } from '../types/types.js'
+import { ImageMeta, ImageRecord, ImageThumbnails } from '../types/types.js'
 
 import { loadConfig } from './lib/context.js'
 import { getDominantPalette } from './lib/dominant.js'
@@ -74,7 +76,8 @@ prog.command('add <src>')
 			processed++
 
 			let sharpImage = sharp(source)
-			let { width, height } = await sharpImage.metadata()
+			let { width, height, iptc } = await sharpImage.metadata()
+			let iptcData = IptcParser.readIPTCData(iptc)
 			let fingerprint = await generateFingerprint(sharpImage)
 			let dominantPalette = await oraPromise(
 				getDominantPalette(sharpImage),
@@ -156,6 +159,12 @@ prog.command('add <src>')
 				}
 			}
 
+			let entryMeta: ImageMeta
+			if (config.includeMetadata) {
+				entryMeta.title = iptcData.object_name
+				entryMeta.caption = iptcData.caption
+			}
+
 			spinner.start('Adding entry to library...')
 
 			/**
@@ -167,6 +176,7 @@ prog.command('add <src>')
 				formats,
 				colors: dominantPalette,
 				thumbnails: entryThumbnails,
+				meta: entryMeta,
 			}
 
 			let store = options.store || config.store || 'imagemeta.json'

types/types.ts

@@ -37,13 +37,21 @@ interface ImageColors {
 	dominant: string
 }
 
+export interface ImageMeta {
+	/** Title field from the image’s EXIF data. */
+	title?: string
+	/** Description field from the image’s EXIF data. */
+	caption?: string
+}
+
 /** Data for each image stored in the library. */
 export interface ImageRecord extends ImageFile {
 	colors: ImageColors
 	/** Encoded blurha.sh placeholder. */
 	blurhash?: string
 	/** Resized versions, keyed to thumbnail size label. */
 	thumbnails?: ImageThumbnails
+	meta?: ImageMeta
 }
 
 type ThumbResizeOptions = RequireAtLeastOne<ResizeOptions, 'width' | 'height'>
@@ -59,6 +67,7 @@ export interface LensConfig {
 	/** Use the filename as a subdirectory for generated files. */
 	useFilenameDirectory?: boolean
 	thumbnails?: ThumbnailOption[]
+	includeMetadata?: boolean
 }
 
 export interface PathParts {

zazen.config.ts

@@ -26,6 +26,7 @@ export default {
 				'error',
 				{ allowObject: true },
 			],
+			'n/file-extension-in-import': 'off',
 		},
 	}),
 }