@synergy-design-system/mcp 1.41.2 → 2.0.0

package/metadata/packages/tokens/BREAKING_CHANGES.md

@@ -0,0 +1,180 @@
+# Handling breaking changes between major versions
+
+This guide holds the required information for migrating from one major version of `@synergy-design-system/tokens` to the next.
+
+> ⚠️ Migrations **must** always be done from one major version to the next to prevent issues (e.g. with types and property changes)
+> This means when moving from `@synergy-design-system@tokens` v1.x to v3.x,
+> you will **have to apply** the changes from v1.x to v2.x first!
+
+---
+
+## Version 3.0
+
+<h3 id="theme-sick2025-v3">Theme: SICK 2025</h3>
+
+#### ⚠️ New default theme SICK 2025
+
+**Associated Ticket(s)**:
+
+- [#1149](https://github.com/synergy-design-system/synergy-design-system/issues/1149)
+
+**Reason**:
+
+With the migration from Synergy version 2 to Synergy version 3, we are adjusting the default export.
+The `light.css` and `dark.css` theme imports now point to `SICK 2025` instead of `SICK 2018`.
+
+This also means that the classes `.syn-theme-light` and `.syn-theme-dark` are now also set for the `SICK 2025` theme instead on the `SICK 2018` theme which was the old default.
+
+**Migration Steps**:
+
+> These steps are only needed if you want to stay on `SICK 2018` **and** have imported `light.css` or `dark.css`!
+
+- Make sure to load the `sick2018_light.css` or `sick2018_dark.css` files instead of `light.css` and `dark.css`.
+
+**Example (before)**:
+
+```css
+/* Points to sick2018_light.css in version 2.x */
+@import "@synergy-design-system/tokens/dist/themes/light.css";
+
+/* Points to sick2018_dark.css in version 2.x */
+@import "@synergy-design-system/tokens/dist/themes/dark.css";
+```
+
+```html
+<!-- Points to syn-sick2018-light in version 2.x  -->
+<div class="syn-theme-light">...</div>
+
+<!-- Points to syn-sick2018-dark in version 2.x  -->
+<div class="syn-theme-dark">...</div>
+```
+
+**Example (after)**:
+
+```css
+/* Adjust to this path to still load the SICK 2018 theme in version 3.x */
+@import "@synergy-design-system/tokens/dist/themes/sick2018_light.css";
+
+/* Adjust to this path to still load the SICK 2018 theme in version 3.x */
+@import "@synergy-design-system/tokens/dist/themes/sick2018_dark.css";
+```
+
+```html
+<!-- Points to syn-sick2025-light in version 3.x  -->
+<div class="syn-theme-light">...</div>
+
+<!-- Points to syn-sick2025-dark in version 3.x  -->
+<div class="syn-theme-dark">...</div>
+```
+
+---
+
+<h3 id="theme-sick2018-v3">Theme: SICK2018</h3>
+
+#### ⚠️ Future deprecation of the SICK 2018 theme
+
+**Associated Ticket(s)**:
+
+- [#1149](https://github.com/synergy-design-system/synergy-design-system/issues/1149)
+
+**Reason**:
+
+The SICK 2018 themes were the primary themes for Synergy version 2.x.
+With the release of Synergy version 3, new applications should use the SICK 2025 theme to be brand-compliant.
+
+> We plan to keep the SICK 2018 theme available until at least the beginning of 2027.
+> It will likely be removed in the first major release after 2027.
+
+**Migration Steps**:
+
+- Upgrade your application to use the new SICK 2025 theme.
+
+---
+
+<h3 id="token-studio-v3">Token Studio</h3>
+
+#### ⚠️ Future deprecation of outdated token studio code
+
+**Associated Ticket(s)**:
+
+- [#1149](https://github.com/synergy-design-system/synergy-design-system/issues/1149)
+
+**Reason**:
+
+TokenStudio is a Figma solution that was used initially for syncing design tokens from Figma to Code.
+With Synergy version 3, we are using Figma Variables for this task.
+The original metadata housed in `src/figma-tokens` is no longer used for Synergy and will therefore be removed.
+
+**Migration Steps**:
+
+- If you still need them, copy the assets located in `src/figma-tokens` to a local destination
+
+---
+
+<h3 id="token-syn-page-background-v3">`--syn-page-background`</h3>
+
+#### ⚠️ Future deprecation
+
+**Associated Ticket(s)**:
+
+- [#1149](https://github.com/synergy-design-system/synergy-design-system/issues/1149)
+
+**Reason**:
+
+The token `--syn-page-background` does not match the semantics of our other tokens. Therefore, we renamed it to `--syn-page-background-color`. The token still works, but will be removed in a future major release.
+
+**Migration Steps**:
+
+Just exchange all occurrences of `--syn-page-background` with `--syn-page-background-color`.
+
+**Example (before)**:
+
+```css
+body {
+  background-color: var(--syn-page-background);
+}
+```
+
+**Example (after)**:
+
+```css
+body {
+  background-color: var(--syn-page-background-color);
+}
+```
+
+---
+
+<!-- USE THIS AS A TEMPLATE FOR ADDITIONAL MIGRATION STEPS
+
+<h3 id="change-VERSION">`Change`</h3>
+
+#### ⚠️ DESCRIBE THE CHANGE HERE
+
+**Associated Ticket(s)**:
+
+- [#1](https://github.com/synergy-design-system/synergy-design-system/issues/1)
+
+**Reason**:
+
+DESCRIBE THE REASON FOR THIS CHANGE
+
+**Migration Steps**:
+
+MIGRATION IN TEXT FORM
+
+**Example (before)**:
+
+```css
+EXAMPLE BEFORE THE CHANGE
+```
+
+**Example (after)**:
+
+```css
+EXAMPLE AFTER THE CHANGE
+```
+
+---
+
+-->

package/metadata/packages/tokens/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 3.0.0
+
+### Major Changes
+
+- [#1160](https://github.com/synergy-design-system/synergy-design-system/pull/1160) [`669cbcb`](https://github.com/synergy-design-system/synergy-design-system/commit/669cbcb9cccce72134beac99ac12a2591f3e3c74) Thanks [@schilchSICKAG](https://github.com/schilchSICKAG)! - Released on: 2026-02-02
+
+  feat: 💥 New default theme SICK 2025
+
+  This release introduces SICK 2025 as the new default theme. The `light.css` and `dark.css` imports now point to SICK 2025 instead of SICK 2018.
+
+  **Key Changes:**
+  - **Breaking:** Default theme changed to SICK 2025 - if you want to continue using SICK 2018, import `sick2018_light.css` or `sick2018_dark.css` instead
+  - **Deprecation Notice:** SICK 2018 theme will be removed in a future major release (expected 2027+)
+  - **Deprecation Notice:** `--syn-page-background` token renamed to `--syn-page-background-color`
+  - **Deprecation Notice:** Token Studio code in `src/figma-tokens` will be removed in a future release
+
+  For detailed migration instructions, please refer to the [breaking changes documentation](https://synergy-design-system.github.io/?path=/docs/packages-tokens-breaking-changes--docs).
+
 ## 2.48.2
 
 ### Patch Changes

package/metadata/packages/tokens/README.md

@@ -15,6 +15,8 @@ Please make sure to install the tokens package as a dependency:
 npm install --save @synergy-design-system/tokens
 ```
 
+> For best compliance, please make sure to install the same version that is also used in your `@synergy-design-system/components` package!
+
 ---
 
 ## Provided tokens