From 8257a791acd957eac8a2df17634e58a7ae6508b0 Mon Sep 17 00:00:00 2001
From: Erik Golinelli <erik@codekraft.it>
Date: Tue, 9 Apr 2024 00:41:46 +0200
Subject: [PATCH] adds some svg info to the output

Took 32 minutes
---
 src/encodeSvg.ts | 96 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 96 insertions(+)

diff --git a/src/encodeSvg.ts b/src/encodeSvg.ts
index c5ff102..a0448a7 100644
--- a/src/encodeSvg.ts
+++ b/src/encodeSvg.ts
@@ -2,6 +2,98 @@ import { Config as SvgoConfig, optimize } from "svgo";
 import { readFile, writeFile } from "node:fs/promises";
 import { getSvgoOptions } from "./utils.js";
 import { OutputData, SVGCompressionOption } from "./types.js";
+import { parseString } from "xml2js";
+
+interface SVGMetadata {
+  width?: string | null;
+  height?: string | null;
+  viewBox?: string | null;
+  title?: string | null;
+  description?: string | null;
+  author?: string | null;
+  creationDate?: string | null;
+  copyright?: string | null;
+  softwareUsed?: string | null;
+  customMetadata?: string[];
+}
+
+async function getSVGMetadata(svgString: string): Promise<{
+  metadata: SVGMetadata;
+  itemCount: number;
+}> {
+  return new Promise((resolve, reject) => {
+    parseString(svgString, (err, result) => {
+      if (err) {
+        reject(err);
+        return;
+      }
+
+      const svgElement = result.svg;
+
+      const metadata: SVGMetadata = {
+        width: svgElement.$.width,
+        height: svgElement.$.height,
+        viewBox: svgElement.$.viewBox,
+      };
+
+      // If width and height are not defined, use viewBox to determine dimensions
+      if ((!metadata.width || !metadata.height) && metadata.viewBox) {
+        const viewBox = metadata.viewBox.split(" ");
+        if (viewBox.length === 4) {
+          metadata.width = viewBox[2];
+          metadata.height = viewBox[3];
+        }
+      }
+
+      if (svgElement.title && svgElement.title.length > 0) {
+        metadata.title = svgElement.title[0];
+      }
+
+      if (svgElement.desc && svgElement.desc.length > 0) {
+        metadata.description = svgElement.desc[0];
+      }
+
+      if (svgElement.metadata && svgElement.metadata.length > 0) {
+        const metadataElements = svgElement.metadata[0];
+        for (const key in metadataElements) {
+          if (key === "$") continue; // Skip attributes
+          const content = metadataElements[key][0];
+          switch (key) {
+            case "author":
+              metadata.author = content;
+              break;
+            case "creationdate":
+              metadata.creationDate = content;
+              break;
+            case "copyright":
+              metadata.copyright = content;
+              break;
+            case "softwareused":
+              metadata.softwareUsed = content;
+              break;
+            default:
+              if (!metadata.customMetadata) {
+                metadata.customMetadata = [];
+              }
+              metadata.customMetadata.push(`${key}: ${content}`);
+              break;
+          }
+        }
+      }
+
+      // remove the metadata that are undefined or false
+      for (const key in metadata as SVGMetadata) {
+        if (!metadata[key as keyof SVGMetadata]) {
+          delete metadata[key as keyof SVGMetadata];
+        }
+      }
+
+      const itemCount = Object.keys(svgElement).length - 1; // Subtract 1 for metadata
+
+      resolve({ metadata, itemCount });
+    });
+  });
+}
 
 /**
  * The function optimizes an SVG file asynchronously using SVGO and writes the optimized SVG to a
@@ -47,6 +139,8 @@ export async function encodeSvg(
    */
   const result = optimizeSvg(originalSvg, getSvgoOptions(options.plugins));
 
+  const { metadata, itemCount } = await getSVGMetadata(result);
+
   // Write the optimized SVG to the destination directory
   return writeFile(distFileName, result, "utf8").then(() => {
     /**
@@ -57,6 +151,8 @@ export async function encodeSvg(
       size: result.length,
       src: srcFilename,
       dist: distFileName,
+      metadata,
+      itemCount,
     } as OutputData;
   });
 }