orcs-design-system 3.4.0 → 3.4.2

package/README.md

@@ -66,6 +66,8 @@ npm version patch
 
 This will bump version patch number and make a commit to current branch.
 
+**Note:** When publishing to public npm, the version is automatically deprecated with a migration message directing users to GitHub Packages. This ensures all users see the deprecation warning when installing.
+
 ### Deploying to GitHub Pages
 
 ORCS automatically deploys to GitHub Pages when a new version is published and merged to master. To manually deploy:
@@ -78,13 +80,13 @@ npm run deploy-storybook
 
 ### GitHub Packages (Recommended)
 
-For internal repositories, use the GitHub Packages version `@teamform/orcs-design-system`. This package is published in parallel with the public version and uses your existing GitHub authentication.
+For internal repositories, use the GitHub Packages version `@orchestrated-io/orcs-design-system`. This package is published in parallel with the public version and uses your existing GitHub authentication.
 
 **Setup:**
 
 1. Add `.npmrc` to your repository root with the following content:
    ```ini
-   @teamform:registry=https://npm.pkg.github.com
+   @orchestrated-io:registry=https://npm.pkg.github.com
    //npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}
    ```
 
@@ -92,7 +94,7 @@ For internal repositories, use the GitHub Packages version `@teamform/orcs-desig
    ```json
    {
      "dependencies": {
-       "orcs-design-system": "npm:@teamform/orcs-design-system@^3.4.0"
+       "orcs-design-system": "npm:@orchestrated-io/orcs-design-system@^3.4.1"
      }
    }
    ```
@@ -101,23 +103,22 @@ For internal repositories, use the GitHub Packages version `@teamform/orcs-desig
 
 **Note:** In GitHub Actions, `GITHUB_TOKEN` is automatically available. For local development, set `GITHUB_TOKEN` as an environment variable with a Personal Access Token (with `read:packages` permission).
 
+**Why use an alias?** By using `npm:@orchestrated-io/orcs-design-system`, you can keep your existing imports unchanged. You'll continue importing as `orcs-design-system` instead of having to update all files to use `@orchestrated-io/orcs-design-system`.
+
 Your imports remain the same:
 ```javascript
 import { Box } from 'orcs-design-system';
 ```
 
-### Public Package (Deprecated)
-
-> **⚠️ Deprecated**: The public npm package (`orcs-design-system`) is deprecated and will be removed by January 2026 at the latest. Please migrate to the GitHub Packages version (`@teamform/orcs-design-system`) as soon as possible.
+For detailed setup instructions, see [DOWNSTREAM_SETUP.md](./DOWNSTREAM_SETUP.md).
 
-If you are still using the public package, you can install it with:
-
-```
-npm i orcs-design-system
-npm i styled-components
-```
+### Public Package (Deprecated)
 
-However, **new projects should use the GitHub Packages version** (see above).
+> **⚠️ DEPRECATED**: The public npm package (`orcs-design-system`) is deprecated and being retired. The public npm version will be removed.
+> 
+> **All versions are marked as deprecated on npm** - users will see a deprecation warning when installing.
+> 
+> **For internal users:** See [DOWNSTREAM_SETUP.md](./DOWNSTREAM_SETUP.md) for migration to GitHub Packages.
 
 ### Using components
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "orcs-design-system",
-  "version": "3.4.0",
+  "version": "3.4.2",
   "engines": {
     "node": ">=20.0.0"
   },
@@ -15,15 +15,16 @@
     "orcs"
   ],
   "homepage": "https://styleguide.orchestrated.io",
-  "licence": {
-    "license": "SEE LICENSE IN LICENCE"
-  },
+  "license": "SEE LICENSE IN LICENCE",
   "module": "es/index.js",
   "main": "es/index.js",
   "repository": {
     "type": "git",
     "url": "https://github.com/orchestrated-io/orcs-design-system.git"
   },
+  "bugs": {
+    "url": "https://github.com/orchestrated-io/orcs-design-system/issues"
+  },
   "sideEffects": false,
   "private": false,
   "scripts": {
@@ -182,6 +183,7 @@
     },
     "webpack-dev-server": "5.2.2",
     "js-yaml": ">=4.1.1",
+    "glob": ">=11.1.0",
     "material-react-table": {
       "@mui/material": "^7.3.5",
       "@mui/icons-material": "^7.3.5"