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

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@synergy-design-system/assets-v1.0.0-main.5](https://github.com/SickDesignSystem/synergy/compare/assets/1.0.0-main.4...assets/1.0.0-main.5) (2023-12-05)
+
+
+### Bug Fixes
+
+* 🤔 fix license file ([#205](https://github.com/SickDesignSystem/synergy/issues/205)) ([247ef50](https://github.com/SickDesignSystem/synergy/commit/247ef505e29fe59ca17c362855bd7095a359b305))
+
+# [@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,210 @@
-BSD 3-Clause License
-
-Copyright (c) 2023, SickDesignSystem
-
-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.
-
-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.
+# Logos (src/logos/LICENSE)
+
+Copyright of SICK AG. Any use is subject to prior approval by SICK AG. 
+
+# Icons (src/icons/LICENSE)
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed 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 CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+
+

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.5",
   "scripts": {
     "lint": "eslint .",
     "fetch-assets": "node scripts/fetch-assets.js",