@synergy-design-system/assets 1.0.0-main.3 → 1.0.0-main.4

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@synergy-design-system/assets-v1.0.0-main.4](https://github.com/SickDesignSystem/synergy/compare/assets/1.0.0-main.3...assets/1.0.0-main.4) (2023-12-04)
+
+
+### Features
+
+* ✨add syn-icon ([#183](https://github.com/SickDesignSystem/synergy/issues/183)) ([add85f5](https://github.com/SickDesignSystem/synergy/commit/add85f553579b5806e1feb0ad78171ca26a7b20d))
+
 # [@synergy-design-system/assets-v1.0.0-main.3](https://github.com/SickDesignSystem/synergy/compare/assets/1.0.0-main.2...assets/1.0.0-main.3) (2023-11-16)
 
 

package/LICENSE

@@ -1,28 +1,8 @@
-BSD 3-Clause License
+# Icons
 
-Copyright (c) 2023, SickDesignSystem
+Find the license which applies to the iccon files in src/icons/LICENSE
 
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
 
-1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
+# Logos
 
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its
-   contributors may be used to endorse or promote products derived from
-   this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+Copyright of SICK AG. Any use is subject to prior approval by SICK AG. 

package/README.md

@@ -1,50 +1,29 @@
 ## Documentation
 
----
+This package is taking care about getting assets (like logos, system icons and default icons) from Figma.
+The folder structure of the assets corresponds to the structure of the Figma page.
+ - **logos:** contains the variants of the SICK brand logo
+ - **icons:** contains the standard icons based on [Material Icons](https://fonts.google.com/icons)
+ - **system-icons:** contains a small subset of icons, that are internally used by the Synergy components
 
-### `FigmaValidator`
+> **Note:** All assets from figma, which should not appear in this package (e.g. documentation), will start with an underscore (e.g. _my-doc-for-an-asset). This assets are getting filtered and ignored by this package.
 
-**Purpose**:  
-This class serves as a utility to interact with the Figma API, providing functionalities specific to the validation of Figma documents.
+### Setup
+To update the assets from Figma, first of all a personal access token in Figma needs to be created.
+The documentation how this can be achieved can be found [here](https://www.figma.com/developers/api#access-tokens).
+The only needed scope is "File content" set to readonly.
 
-- It fetches page names from a given Figma file.
-- It checks if essential pages like 'Assets', 'Tokens', and 'Components' are missing from the provided Figma file.
+After the creation of the personal access token, it needs to be saved in a ***.env*** file with the variable ***"FIGMA_PERSONAL_ACCESS_TOKEN"***.
+It should look like following: 
 
-**Key Functions**:
+```
+FIGMA_PERSONAL_ACCESS_TOKEN = "my-personal-access-token"
+```
 
-- `getPageNames(fileId)`: Fetches and returns the names of all pages in a given Figma file.
-- `getMissingPages(fileId)`: Checks and returns any of the required pages (Assets, Tokens, Components) that are missing from the Figma file.
+### Update assets from Figma
+If something in the Figma assets got changed, the assets of this package also needs to be updated.
+To update the assets run following in the terminal of the assets package folder:
+```
+pnpm fetch-assets
+```
 
----
-
-### `optimizeSVGs`
-
-**Purpose**:  
-This function optimizes SVG files in a given directory, improving their performance and reducing their file size.
-
-- It uses the SVGO library to carry out optimizations.
-- It is set to remove any `fill` attributes and add a default `fill` attribute set to `currentColor`.
-
-**Key Function**:
-
-- `optimizeSVGs(svgDirPath)`: Iterates over SVG files in a specified directory, and optimizes them.
-
----
-
-### `fetchAssets`
-
-**Purpose**:  
-This script automates the process of fetching design assets from Figma and saving them to a local directory.
-
-- It makes use of the `FigmaExporter` class to fetch assets.
-- It processes PNG and SVG assets differently and ensures that unwanted assets (those starting with `_`) are not fetched.
-- At the end of the process, it clears the target directory (`./src`) and then fetches the assets anew.
-- If any SVGs are found in the `./src/icons` directory after fetching, they are optimized using the previously mentioned `optimizeSVGs` function.
-
-**Key Function**:
-
-- `fetchAssets()`: The main function that orchestrates the fetching, filtering, and saving of design assets from Figma.
-
-**To run this script and fetch the assets you will have to navigate to the *assets* package folder and write on the terminal: *'pnpm fetch-assets'*. This command will first remove everything on the *src* folder and then fetch the assets from Figma and create the folders *logos* and *icons* and store them accordingly.**
-
-- Also important to note, for this action to work you will need to have an ***.env*** file with the string variable ***"FIGMA_PERSONAL_ACCESS_TOKEN"*** on it.

package/package.json

@@ -13,7 +13,7 @@
     "dotenv": "^16.3.1",
     "eslint": "^8.47.0",
     "eslint-plugin-import": "^2.28.1",
-    "figma-export-assets": "github:mariohamann/figma-export-assets",
+    "figma-export-assets": "^1.0.1",
     "rimraf": "^5.0.1",
     "semantic-release": "^19.0.5",
     "semantic-release-monorepo": "^7.0.5",
@@ -22,8 +22,18 @@
     "@synergy-design-system/eslint-config-syn": "0.1.0"
   },
   "exports": {
-    ".": "./build/js/index.js"
+    ".": {
+      "types": "./src/default-icons.d.ts",
+      "import": "./src/default-icons.js"
+    },
+    "./icons/*": "./src/icons/*",
+    "./logos/*": "./src/logos/*",
+    "./default-icons.js": {
+      "types": "./src/default-icons.js",
+      "import": "./src/default-icons.js"
+    }
   },
+  "types": "./src/default-icons.d.ts",
   "homepage": "https://github.com/SickDesignSystem/synergy/tree/main/packages/assets",
   "keywords": [
     "Static Assets",
@@ -36,9 +46,12 @@
   ],
   "files": [
     "src/logos",
+    "src/icons",
+    "src/default-icons.d.ts",
+    "src/default-icons.js",
     "CHANGELOG.md"
   ],
-  "license": "BSD-3-Clause",
+  "license": "SEE LICENSE IN LICENSE",
   "name": "@synergy-design-system/assets",
   "repository": {
     "type": "git",
@@ -96,8 +109,7 @@
     ]
   },
   "type": "module",
-  "types": "./build/js/index.d.ts",
-  "version": "1.0.0-main.3",
+  "version": "1.0.0-main.4",
   "scripts": {
     "lint": "eslint .",
     "fetch-assets": "node scripts/fetch-assets.js",