@synergy-design-system/assets 1.11.1 → 1.11.2

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@synergy-design-system/assets-v1.11.2](https://github.com/synergy-design-system/synergy-design-system/compare/assets/1.11.1...assets/1.11.2) (2024-12-02)
+
+
+### Bug Fixes
+
+* 🐛 Assets release process ([#700](https://github.com/synergy-design-system/synergy-design-system/issues/700)) ([c28647f](https://github.com/synergy-design-system/synergy-design-system/commit/c28647fa3fbde952e649c67bf7d98df6060ac78b))
+
 # [@synergy-design-system/assets-v1.11.1](https://github.com/synergy-design-system/synergy-design-system/compare/assets/1.11.0...assets/1.11.1) (2024-12-02)
 
 

package/dist/createSpritesheet.d.ts

@@ -0,0 +1,9 @@
+import { defaultIcons } from './default-icons.js';
+type IconKeys = keyof typeof defaultIcons;
+/**
+ * Creates a SVG sprite sheet with the given icons.
+ * @param icons The icon keys to use
+ * @returns String representation of the SVG sprite sheet
+ */
+export declare const createSpriteSheet: (icons: IconKeys[]) => string;
+export {};

package/dist/createSpritesheet.js

@@ -0,0 +1,24 @@
+import { defaultIcons } from './default-icons.js';
+/**
+ * Creates a SVG sprite sheet with the given icons.
+ * @param icons The icon keys to use
+ * @returns String representation of the SVG sprite sheet
+ */
+export const createSpriteSheet = (icons) => {
+    const foundIcons = Object
+        .entries(defaultIcons)
+        .filter(([key]) => icons.includes(key));
+    const symbols = foundIcons
+        // Make sure to sort the icons by key always.
+        // This may prevent problems when saving the sheet in the filesystem
+        // and new items are added to the icons object.
+        .sort(([a], [b]) => a.localeCompare(b))
+        .map(([key, value]) => value
+        .replace('<svg', `<symbol id="${key}"`)
+        .replace('</svg>', '</symbol>'));
+    return `
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+  ${symbols.join('\n\t')}
+</svg>
+  `.trim();
+};

package/dist/createSpritesheetCli.d.ts

@@ -0,0 +1,2 @@
+#! /usr/bin/env node
+export {};

package/dist/createSpritesheetCli.js

@@ -0,0 +1,59 @@
+#! /usr/bin/env node
+/* eslint-disable no-console */
+import { createSpriteSheet } from './createSpritesheet.js';
+import { defaultIcons } from './default-icons.js';
+/**
+ * Creates a help message for the CLI.
+ * @returns Help message
+ */
+const helpMessage = (usageError = '') => `Usage: syn-create-spritesheet --icons=icon1,icon2,icon3
+
+Creates a spritesheet string from a list of icons.
+Each icon identifier is a valid icon name for an icon in the synergy icon library.
+
+Using to save the spritesheet string to a file:
+syn-create-spritesheet --icons=a,b,c > icons.svg
+
+Please have a look at https://synergy-design-system.github.io/?path=/docs/icon-search--docs for icon names
+${usageError && `
+Error: ${usageError}`}
+`;
+const args = process.argv.slice(2);
+// Sanitize the arguments
+const argumentsObject = args.reduce((acc, arg) => {
+    const [originalKey, originalValue] = arg.trim().split('=');
+    // Skip if the option does not have a value
+    if (!originalValue) {
+        return acc;
+    }
+    const key = originalKey.trim().replace(/^--/, '');
+    const finalValue = originalValue.includes(',') || key === 'icons'
+        ? originalValue.split(',').map((icon) => icon.trim())
+        : originalValue.trim();
+    acc[key] = finalValue;
+    return acc;
+}, {});
+if (args.length === 0) {
+    console.log(helpMessage('Please provide at least one icon.'));
+    process.exit(1);
+}
+// Check if the icons are valid
+const allowedIconNames = Object.keys(defaultIcons);
+const { icons } = argumentsObject;
+if (!icons || icons.length === 0) {
+    console.log(helpMessage('Please provide at least one icon.'));
+    process.exit(2);
+}
+const validIcons = icons.filter((icon) => allowedIconNames.includes(icon));
+if (validIcons?.length !== icons.length) {
+    const invalidIcons = icons.filter((icon) => !allowedIconNames.includes(icon));
+    console.log(helpMessage(`
+Some icons are not valid!
+The following icons could not be detected:
+  - ${invalidIcons.join('\n\t- ')}
+
+Please remove them and try again, e.g. by using the following command: syn-create-spritesheet --icons=${validIcons.join(',')}`));
+    process.exit(-3);
+}
+console.log(createSpriteSheet(validIcons));
+process.exit(0);