@spectrum-web-components/icons-workflow 0.50.0-beta.8 → 0.50.0-beta.9

package/bin/build-icons-mapping.js

@@ -0,0 +1,90 @@
+/* eslint-disable @typescript-eslint/explicit-function-return-type */
+/*
+Copyright 2020 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+import { getComponentName } from './build.js';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+/*
+ * You can run this script by running the `build-icons-mapping ` on `packages/icons-workflow/package.json`,
+ * which generates the icons mapping from an internal CSV file.
+ * This is a manual step and should only be run when the icons team provides updates.
+ * Place the CSV file under the `packages/icons-workflow/bin` folder and run the script to generate the new JSON mapping file.
+ * This JSON mapping should be committed to the repository.
+ */
+const saveIconsMapping = async () => {
+    // check if there is file with .csv extension in the bin folder
+    const files = fs.promises.readdir(__dirname);
+    let data = '';
+    try {
+        const fileNames = await files;
+        const csvFile = fileNames.find((file) => file.endsWith('.csv'));
+        if (csvFile) {
+            data = await fs.promises.readFile(
+                path.join(__dirname, csvFile),
+                'utf8'
+            );
+        }
+    } catch (error) {
+        throw new Error(`Error reading the bin directory: ${error.message}`);
+    }
+
+    if (!data) {
+        throw new Error(
+            'No csv file found in the src folder. Please make sure you have the csv file in the "packages/icons-workflow/bin" folder'
+        );
+    }
+
+    const rows = data.split('\n');
+    const mapping = {};
+    rows.forEach((row) => {
+        const columns = row.split(',');
+        // if the third column says "name change"
+        if (columns.length >= 3 && columns[2] === 'name change') {
+            const oldName = getComponentName(columns[0]);
+            const newName = getComponentName(columns[1]);
+
+            // skip if the old or new name is a number
+            if (
+                !Number.isNaN(Number(oldName)) ||
+                !Number.isNaN(Number(newName))
+            ) {
+                return;
+            }
+
+            mapping[oldName] = newName;
+            mapping[newName] = oldName;
+        }
+    });
+
+    if (Object.keys(mapping).length === 0) {
+        console.warn('No valid name changes found in the CSV file.');
+    }
+
+    const outputPath = path.join(__dirname, './icons-mapping.json');
+    try {
+        await fs.promises.writeFile(
+            outputPath,
+            JSON.stringify(mapping),
+            'utf8'
+        );
+    } catch (error) {
+        throw new Error(`Error saving the icons mapping: ${error.message}`);
+    }
+};
+
+await saveIconsMapping();

package/bin/build.js

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/explicit-function-return-type */
 /*
 Copyright 2020 Adobe. All rights reserved.
 This file is licensed to you under the Apache License, Version 2.0 (the "License");
@@ -18,13 +19,12 @@ import prettier from 'prettier';
 import Case from 'case';
 import { fileURLToPath } from 'url';
 
+import systemsIconMapping from './icons-mapping.json' assert { type: 'json' };
+
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 const rootDir = path.join(__dirname, '../../../');
 
-const iconsPath = process.argv.slice(2)[0];
-const keepColors = process.argv.slice(2)[1];
-
 const disclaimer = `
 /*
 Copyright 2020 Adobe. All rights reserved.
@@ -38,25 +38,37 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */`;
 
-const icons = (await fg(`${rootDir}/node_modules/${iconsPath}/**.svg`)).sort();
+const S1IConsPackageDir = '@adobe/spectrum-css-workflow-icons/dist/18';
+const S2IConsPackageDir =
+    '@adobe/spectrum-css-workflow-icons-s2/dist/assets/svg';
+const keepColors = '';
+
+const ensureDirectoryExists = (dirPath) => {
+    if (!fs.existsSync(dirPath)) {
+        fs.mkdirSync(dirPath);
+    }
+};
+
+const directories = [
+    `${rootDir}packages/icons-workflow/src`,
+    `${rootDir}packages/icons-workflow/src/icons`,
+    `${rootDir}packages/icons-workflow/src/icons-s2`,
+    `${rootDir}packages/icons-workflow/src/elements`,
+    `${rootDir}packages/icons-workflow/icons`,
+];
+
+directories.forEach(ensureDirectoryExists);
 
-if (!fs.existsSync(`${rootDir}packages/icons-workflow/src`)) {
-    fs.mkdirSync(`${rootDir}packages/icons-workflow/src`);
-}
-if (!fs.existsSync(`${rootDir}packages/icons-workflow/src/icons`)) {
-    fs.mkdirSync(`${rootDir}packages/icons-workflow/src/icons`);
-}
-if (!fs.existsSync(`${rootDir}packages/icons-workflow/src/elements`)) {
-    fs.mkdirSync(`${rootDir}packages/icons-workflow/src/elements`);
-}
-if (!fs.existsSync(`${rootDir}packages/icons-workflow/icons`)) {
-    fs.mkdirSync(`${rootDir}packages/icons-workflow/icons`);
-}
 fs.writeFileSync(
     path.join(rootDir, 'packages', 'icons-workflow', 'src', 'icons.ts'),
     disclaimer,
     'utf-8'
 );
+fs.writeFileSync(
+    path.join(rootDir, 'packages', 'icons-workflow', 'src', 'icons-s2.ts'),
+    disclaimer,
+    'utf-8'
+);
 const manifestPath = path.join(
     rootDir,
     'packages',
@@ -71,210 +83,299 @@ let manifestImports = `import {
 } from '@spectrum-web-components/base';\r\n`;
 let manifestListings = `\r\nexport const iconManifest = [\r\n`;
 
-icons.forEach((i) => {
-    const svg = fs.readFileSync(i, 'utf-8');
-    let id = path.basename(i, '.svg').replace('S_', '').replace('_22_N', '');
-    if (id.search(/^Ad[A-Z]/) !== -1) {
-        id = id.replace(/^Ad/, '');
-        id += 'Advert';
-    }
-    const ComponentName = id === 'github' ? 'GitHub' : Case.pascal(id);
-    const $ = load(svg, {
-        xmlMode: true,
-    });
-    const title = Case.capital(id);
-    const fileName = `${id}.ts`;
-    const location = path.join(
-        rootDir,
-        'packages/icons-workflow/src/icons',
-        fileName
-    );
-
-    if (!Number.isNaN(Number(ComponentName[0]))) {
-        return;
+const defaultIconImport = `import { DefaultIcon as AlternateIcon } from '../DefaultIcon.js';\r\n`;
+
+// A function that process the raw svg name and returns the component name
+export const getComponentName = (i) => {
+    let id = path
+        .basename(i, '.svg')
+        .replace(/^(S2_Icon_|S_)/, '')
+        .replace(/(_20_N|_22x20_N|_18_N@2x)$/, '');
+    if (i.startsWith('Ad')) {
+        id = i.replace(/^Ad/, '') + 'Advert';
     }
+    const replacements = {
+        UnLink: 'Unlink',
+        TextStrikeThrough: 'TextStrikethrough',
+        github: 'GitHub',
+    };
+    return Case.pascal(replacements[id] || id);
+};
 
-    $('*').each((index, el) => {
-        if (el.name === 'svg') {
-            $(el).attr('aria-hidden', '...');
-            $(el).attr('role', 'img');
-            if (keepColors !== 'keep') {
-                $(el).attr('fill', 'currentColor');
-            }
-            $(el).attr('aria-label', '...');
-            $(el).removeAttr('id');
-            $(el).attr('width', '...');
-            $(el).attr('height', '...');
+async function buildIcons(icons, tag, iconsNameList) {
+    icons.forEach((i) => {
+        const svg = fs.readFileSync(i, 'utf-8');
+        let id = path
+            .basename(i, '.svg')
+            .replace('S2_Icon_', '')
+            .replace('_20_N', '')
+            .replace('_22x20_N', '');
+        if (id.search(/^Ad[A-Z]/) !== -1) {
+            id = id.replace(/^Ad/, '');
+            id += 'Advert';
         }
-        if (el.name === 'defs') {
-            $(el).remove();
+
+        if (id === 'UnLink') {
+            id = 'Unlink';
         }
-        Object.keys(el.attribs).forEach((x) => {
-            if (x === 'class') {
-                $(el).removeAttr(x);
-            }
-            if (keepColors !== 'keep' && x === 'stroke') {
-                $(el).attr(x, 'currentColor');
-            }
-            if (keepColors !== 'keep' && x === 'fill') {
-                $(el).attr(x, 'currentColor');
-            }
+        if (id === 'TextStrikeThrough') {
+            id = 'TextStrikethrough';
+        }
+
+        let ComponentName = id === 'github' ? 'GitHub' : Case.pascal(id);
+
+        if (ComponentName === 'TextStrikeThrough') {
+            ComponentName = 'TextStrikethrough';
+        }
+        if (ComponentName === 'UnLink') {
+            ComponentName = 'Unlink';
+        }
+
+        const $ = load(svg, {
+            xmlMode: true,
         });
-    });
+        const title = Case.capital(id);
+        const fileName = `${id}.ts`;
+        const location = path.join(
+            rootDir,
+            'packages/icons-workflow/src',
+            tag,
+            fileName
+        );
 
-    const iconLiteral = `
-    ${disclaimer}
-
-    import {tag as html, TemplateResult} from '../custom-tag.js';
-
-    export {setCustomTemplateLiteralTag} from '../custom-tag.js';
-    export const ${ComponentName}Icon = ({
-    width = 24,
-    height = 24,
-    hidden = false,
-    title = '${title}',
-    } = {},): string | TemplateResult => {
-    return html\`${$('svg')
-        .toString()
-        .replace(
-            'aria-hidden="..."',
-            "aria-hidden=${hidden ? 'true' : 'false'}"
-        )
-        .replace('width="..."', 'width=${width}')
-        .replace('height="..."', 'height=${height}')
-        .replace('aria-label="..."', 'aria-label=${title}')}\`;
-    }
-`;
-
-    prettier
-        .format(iconLiteral, {
-            printWidth: 100,
-            tabWidth: 2,
-            useTabs: false,
-            semi: true,
-            singleQuote: true,
-            trailingComma: 'all',
-            bracketSpacing: true,
-            jsxBracketSameLine: false,
-            arrowParens: 'avoid',
-            parser: 'typescript',
-        })
-        .then((icon) => {
-            fs.writeFileSync(location, icon, 'utf-8');
+        if (!Number.isNaN(Number(ComponentName[0]))) {
+            return;
+        }
+
+        $('*').each((index, el) => {
+            if (el.name === 'svg') {
+                $(el).attr('aria-hidden', '...');
+                $(el).attr('role', 'img');
+                if (keepColors !== 'keep') {
+                    $(el).attr('fill', 'currentColor');
+                }
+                $(el).attr('aria-label', '...');
+                $(el).removeAttr('id');
+                $(el).attr('width', '...');
+                $(el).attr('height', '...');
+            }
+            if (el.name === 'defs') {
+                $(el).remove();
+            }
+            Object.keys(el.attribs).forEach((x) => {
+                if (x === 'class') {
+                    $(el).removeAttr(x);
+                }
+                if (keepColors !== 'keep' && x === 'stroke') {
+                    $(el).attr(x, 'currentColor');
+                }
+                if (keepColors !== 'keep' && x === 'fill') {
+                    $(el).attr(x, 'currentColor');
+                }
+            });
         });
 
-    const exportString = `export {${ComponentName}Icon} from './icons/${id}.js';\r\n`;
-    fs.appendFileSync(
-        path.join(rootDir, 'packages', 'icons-workflow', 'src', 'icons.ts'),
-        exportString,
-        'utf-8'
-    );
-
-    const iconElementName = `sp-icon-${Case.kebab(ComponentName)}`;
-    const iconElement = `
-    ${disclaimer}
-
-    import {
-        html,
-        TemplateResult
-    } from '@spectrum-web-components/base';
-    import {
-        IconBase
-    } from '@spectrum-web-components/icon';
-
-    import {
-        ${ComponentName}Icon
-    } from '../icons/${id}.js';
-    import {
-        setCustomTemplateLiteralTag
-    } from '../custom-tag.js';
-
-    /**
-     * @element ${iconElementName}
-     */
-    export class Icon${ComponentName} extends IconBase {
-        protected override render(): TemplateResult {
-            setCustomTemplateLiteralTag(html);
-            return ${ComponentName}Icon({hidden: !this.label, title: this.label}) as TemplateResult;
+        const iconLiteral = `
+        ${disclaimer}
+    
+        import {tag as html, TemplateResult} from '../custom-tag.js';
+    
+        export {setCustomTemplateLiteralTag} from '../custom-tag.js';
+        export const ${ComponentName}Icon = ({
+        width = 24,
+        height = 24,
+        hidden = false,
+        title = '${title}',
+        } = {},): string | TemplateResult => {
+        return html\`${$('svg')
+            .toString()
+            .replace(
+                'aria-hidden="..."',
+                "aria-hidden=${hidden ? 'true' : 'false'}"
+            )
+            .replace('width="..."', 'width="${width}"')
+            .replace('height="..."', 'height="${height}"')
+            .replace('aria-label="..."', 'aria-label="${title}"')}\`;
         }
-    }
     `;
-    prettier
-        .format(iconElement, {
-            printWidth: 100,
-            tabWidth: 2,
-            useTabs: false,
-            semi: true,
-            singleQuote: true,
-            trailingComma: 'all',
-            bracketSpacing: true,
-            jsxBracketSameLine: false,
-            arrowParens: 'avoid',
-            parser: 'typescript',
-        })
-        .then((iconElementFile) => {
-            fs.writeFileSync(
-                path.join(
-                    rootDir,
-                    'packages',
-                    'icons-workflow',
-                    'src',
-                    'elements',
-                    `Icon${id}.ts`
-                ),
-                iconElementFile,
-                'utf-8'
-            );
-        });
 
-    const iconRegistration = `
-    ${disclaimer}
+        prettier
+            .format(iconLiteral, {
+                printWidth: 100,
+                tabWidth: 2,
+                useTabs: false,
+                semi: true,
+                singleQuote: true,
+                trailingComma: 'all',
+                bracketSpacing: true,
+                jsxBracketSameLine: false,
+                arrowParens: 'avoid',
+                parser: 'typescript',
+            })
+            .then((icon) => {
+                fs.writeFileSync(location, icon, 'utf-8');
+            });
+
+        const exportString = `export {${ComponentName}Icon} from './${tag}/${id}.js';\r\n`;
+        fs.appendFileSync(
+            path.join(
+                rootDir,
+                'packages',
+                'icons-workflow',
+                'src',
+                tag + '.ts'
+            ),
+            exportString,
+            'utf-8'
+        );
 
-    import { Icon${ComponentName} } from '../src/elements/Icon${id}.js';
-    import { defineElement } from '@spectrum-web-components/base/src/define-element.js';
+        const iconElementName = `sp-icon-${Case.kebab(ComponentName)}`;
 
-    defineElement('${iconElementName}', Icon${ComponentName});
+        const currenVersionIconImport = `import { ${ComponentName}Icon as CurrentIcon } from '../${tag}/${id}.js';\r\n`;
 
-    declare global {
-        interface HTMLElementTagNameMap {
-            '${iconElementName}': Icon${ComponentName};
+        // check if the icon is present in the other version
+        let otherVersionIconImport = defaultIconImport;
+
+        const alternateTag = tag === 'icons' ? 'icons-s2' : 'icons';
+        // if there is a mapping icon found from the above iconset update otherVersionIconImport
+        if (systemsIconMapping[ComponentName]) {
+            otherVersionIconImport = `import { ${systemsIconMapping[ComponentName]}Icon as AlternateIcon } from '../${alternateTag}/${systemsIconMapping[ComponentName]}.js';\r\n`;
+        } else if (iconsNameList.includes(ComponentName)) {
+            // if there is a no mapping icon found reset to DefaultIcon
+            otherVersionIconImport = `import { ${ComponentName}Icon as AlternateIcon } from '../${alternateTag}/${id}.js';\r\n`;
         }
-    }
-    `;
-    prettier
-        .format(iconRegistration, {
-            printWidth: 100,
-            tabWidth: 2,
-            useTabs: false,
-            semi: true,
-            singleQuote: true,
-            trailingComma: 'all',
-            bracketSpacing: true,
-            jsxBracketSameLine: false,
-            arrowParens: 'avoid',
-            parser: 'typescript',
-        })
-        .then((iconRegistrationFile) => {
-            fs.writeFileSync(
-                path.join(
-                    rootDir,
-                    'packages',
-                    'icons-workflow',
-                    'icons',
-                    `${iconElementName}.ts`
-                ),
-                iconRegistrationFile,
-                'utf-8'
-            );
-        });
 
-    const importStatement = `\r\nimport '@spectrum-web-components/icons-workflow/icons/${iconElementName}.js';`;
-    const metadata = `{name: '${Case.sentence(
-        ComponentName
-    )}', tag: '<${iconElementName}>', story: (size: string): TemplateResult => html\`<${iconElementName} size=\$\{size\}></${iconElementName}>\`},\r\n`;
-    manifestImports += importStatement;
-    manifestListings += metadata;
+        const spectrumVersion = tag === 'icons' ? 1 : 2;
+
+        const iconElement = `
+        ${disclaimer}
+        
+        import {
+            html,
+            TemplateResult
+        } from '@spectrum-web-components/base';
+        import {
+            IconBase
+        } from '@spectrum-web-components/icon';
+        import {
+            setCustomTemplateLiteralTag
+        } from '../custom-tag.js';
+        
+        ${currenVersionIconImport}
+        ${otherVersionIconImport}
+        
+        /**
+         * @element ${iconElementName}
+         */
+        export class Icon${ComponentName} extends IconBase {
+            protected override render(): TemplateResult {
+                setCustomTemplateLiteralTag(html);
+    
+                if(this.spectrumVersion === ${spectrumVersion}){
+                    return CurrentIcon({ hidden: !this.label, title: this.label }) as TemplateResult;
+                }
+                return AlternateIcon({ hidden: !this.label, title: this.label }) as TemplateResult;
+    
+            }
+        }
+        `;
+
+        prettier
+            .format(iconElement, {
+                printWidth: 100,
+                tabWidth: 2,
+                useTabs: false,
+                semi: true,
+                singleQuote: true,
+                trailingComma: 'all',
+                bracketSpacing: true,
+                jsxBracketSameLine: false,
+                arrowParens: 'avoid',
+                parser: 'typescript',
+            })
+            .then((iconElementFile) => {
+                fs.writeFileSync(
+                    path.join(
+                        rootDir,
+                        'packages',
+                        'icons-workflow',
+                        'src',
+                        'elements',
+                        `Icon${id}.ts`
+                    ),
+                    iconElementFile,
+                    'utf-8'
+                );
+            });
+
+        const iconRegistration = `
+        ${disclaimer}
+    
+        import { Icon${ComponentName} } from '../src/elements/Icon${id}.js';
+        import { defineElement } from '@spectrum-web-components/base/src/define-element.js';
+    
+        defineElement('${iconElementName}', Icon${ComponentName});
+    
+        declare global {
+            interface HTMLElementTagNameMap {
+                '${iconElementName}': Icon${ComponentName};
+            }
+        }
+        `;
+
+        prettier
+            .format(iconRegistration, {
+                printWidth: 100,
+                tabWidth: 2,
+                useTabs: false,
+                semi: true,
+                singleQuote: true,
+                trailingComma: 'all',
+                bracketSpacing: true,
+                jsxBracketSameLine: false,
+                arrowParens: 'avoid',
+                parser: 'typescript',
+            })
+            .then((iconRegistrationFile) => {
+                fs.writeFileSync(
+                    path.join(
+                        rootDir,
+                        'packages',
+                        'icons-workflow',
+                        'icons',
+                        `${iconElementName}.ts`
+                    ),
+                    iconRegistrationFile,
+                    'utf-8'
+                );
+            });
+
+        const importStatement = `\r\nimport '@spectrum-web-components/icons-workflow/icons/${iconElementName}.js';`;
+        const metadata = `{name: '${Case.sentence(
+            ComponentName
+        )}', tag: '<${iconElementName}>', story: (size: string): TemplateResult => html\`<${iconElementName} size=\$\{size\}></${iconElementName}>\`},\r\n`;
+        manifestImports += importStatement;
+        manifestListings += metadata;
+    });
+}
+
+const iconsV1 = (
+    await fg(`${rootDir}/node_modules/${S1IConsPackageDir}/**.svg`)
+).sort();
+
+const iconsV2 = (
+    await fg(`${rootDir}/node_modules/${S2IConsPackageDir}/**.svg`)
+).sort();
+
+const iconsV1NameList = iconsV1.map((i) => {
+    return getComponentName(i);
 });
+const iconsV2NameList = iconsV2.map((i) => {
+    return getComponentName(i);
+});
+
+await buildIcons(iconsV1, 'icons', iconsV2NameList);
+await buildIcons(iconsV2, 'icons-s2', iconsV1NameList);
 
 const exportString = `\r\nexport { setCustomTemplateLiteralTag } from './custom-tag.js';\r\n`;
 fs.appendFileSync(
@@ -282,6 +383,7 @@ fs.appendFileSync(
     exportString,
     'utf-8'
 );
+
 fs.appendFileSync(
     manifestPath,
     `${manifestImports}${manifestListings}];\r\n`,

package/icons/sp-icon-accessibility.d.ts

@@ -0,0 +1,6 @@
+import { IconAccessibility } from '../src/elements/IconAccessibility.js';
+declare global {
+    interface HTMLElementTagNameMap {
+        'sp-icon-accessibility': IconAccessibility;
+    }
+}

package/icons/sp-icon-accessibility.js

@@ -0,0 +1,2 @@
+"use strict";import{IconAccessibility as i}from"../src/elements/IconAccessibility.js";import{defineElement as e}from"@spectrum-web-components/base/src/define-element.js";e("sp-icon-accessibility",i);
+//# sourceMappingURL=sp-icon-accessibility.js.map

package/icons/sp-icon-accessibility.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["sp-icon-accessibility.ts"],
+  "sourcesContent": ["/*\nCopyright 2020 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\n\nimport { IconAccessibility } from '../src/elements/IconAccessibility.js';\nimport { defineElement } from '@spectrum-web-components/base/src/define-element.js';\n\ndefineElement('sp-icon-accessibility', IconAccessibility);\n\ndeclare global {\n  interface HTMLElementTagNameMap {\n    'sp-icon-accessibility': IconAccessibility;\n  }\n}\n"],
+  "mappings": "aAYA,OAAS,qBAAAA,MAAyB,uCAClC,OAAS,iBAAAC,MAAqB,sDAE9BA,EAAc,wBAAyBD,CAAiB",
+  "names": ["IconAccessibility", "defineElement"]
+}