chore: add changeset and migration guide infos

swisspost · Apr 5, 2024 · ee73031 · ee73031
1 parent 9e7c919
commit ee73031
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 0 deletions.
diff --git a/.changeset/giant-glasses-sniff.md b/.changeset/giant-glasses-sniff.md
@@ -0,0 +1,12 @@
+---
+'@swisspost/design-system-components': major
+---
+
+Updated the package entry properties in the package.json to the by stencil recommended files:
+
+- Updated the `main` property from `loader/index.cjs.js` to `dist/index.cjs.js`
+- Updated the `module` property from `loader/index.js` to `dist/loader.js`
+- Updated the `types` property from `loader/index.d.ts` to `dist/types/index.d.ts`
+- Removed the `es2017` property
+
+The usage of the `@swisspost/design-system-components/loader` entry files are still available and should be used to get the lazy-loaded components.
diff --git a/...ages/documentation/src/stories/getting-started/migration-guide/migrationv6-7.component.ts b/...ages/documentation/src/stories/getting-started/migration-guide/migrationv6-7.component.ts
@@ -174,6 +174,33 @@ export class MigrationV67Component extends LitElement {
               <h4>WebComponents</h4>
 
               <ul>
+                <li class="mb-3">
+                  <p>
+                    <span class="tag tag-sm tag-danger">Breaking</span> Updated the package entry
+                    file paths within the <em>package.json</em> to the paths, recommended by
+                    stencil:
+                  </p>
+                  <ul>
+                    <li>
+                      updated the <code>main</code> property from
+                      <code>loader/index.cjs.js</code> to <code>dist/index.cjs.js</code>
+                    </li>
+                    <li>
+                      updated the <code>module</code> property from <code>loader/index.js</code> to
+                      <code>dist/loader.js</code>
+                    </li>
+                    <li>
+                      updated the <code>types</code> property from <code>loader/index.d.ts</code> to
+                      <code>dist/types/index.d.ts</code>
+                    </li>
+                    <li>removed the <code>es2017</code> property</li>
+                  </ul>
+                  <p class="info">
+                    The usage of the <code>@swisspost/design-system-components/loader</code> entry
+                    files are still available and should be used (as documented) to get the
+                    lazy-loaded components.
+                  </p>
+                </li>
                 <li class="mb-3">
                   <p>
                     <span class="tag tag-sm tag-danger">Breaking</span> Renamed all