add static svg sprite sheet file (#1763)

Co-authored-by: Cristiano Rastelli <cristiano.rastelli@hashicorp.com>
Co-authored-by: Alex <alex-ju@users.noreply.github.com>

.changeset/mighty-singers-prove.md

@@ -0,0 +1,5 @@
+---
+"@hashicorp/flight-icons": minor
+---
+
+Added static SVG sprite sheet file

packages/flight-icons/scripts/build-parts/generateBundleSVGSprite.ts

@@ -26,7 +26,16 @@ export async function generateBundleSVGSprite({ config, catalog } : { config: Co
     const sprites = svgstore({
         // see https://github.com/svgstore/svgstore#options for details
         renameDefs: false, // we already create unique IDs (using the icon name) in the SVGO step
-        svgAttrs: { width: '0', height: '0', class: 'flight-sprite-container', 'aria-hidden': 'true'  },
+        svgAttrs: { 
+            width: '0',
+            height: '0',
+            // some browsers will not correctly render remote <use> references unless the remote document has the correct namespace
+            xmlns: "http://www.w3.org/2000/svg",
+            // Next.js expects there to be a viewBox attribute to calculate dimensions; while this isn't actually useful in the case of an SVG sprite, it does prevent Next.js from throwing an error about being unable to parse the file
+            viewBox: "0 0 0 0",
+            class: 'flight-sprite-container',
+            'aria-hidden': 'true'
+        },
     });
 
     // add the SVGs to the sprite
@@ -51,4 +60,11 @@ export async function generateBundleSVGSprite({ config, catalog } : { config: Co
 
     // update the SVG "module"
     await fs.writeFile(`${config.mainFolder}/svg-sprite/svg-sprite-module.js`, svgModuleContent);
+
+    let svgFileContent = '<!--\n * Copyright (c) HashiCorp, Inc.\n * SPDX-License-Identifier: MPL-2.0\n-->\n\n';
+    svgFileContent += '<!-- THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. -->\n';
+    svgFileContent += `${svgSpriteContent}\n`;
+
+    // update the SVG file
+    await fs.writeFile(`${config.mainFolder}/svg-sprite/svg-sprite.svg`, svgFileContent);
 }