@tumaet/prompt-ui-components 1.0.10 → 1.0.11

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 TUM Applied Education Technologies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,106 @@
+# prompt-ui-components
+
+A shared UI component library for the **AET Prompt** system, built on [shadcn/ui](https://ui.shadcn.dev/).
+
+Components are designed for **Module Federation** singleton usage, which ensures:
+- A **consistent UI experience** across microfrontends
+- **Reduced bundle size** by avoiding duplicate component loading
+- **Unified UI state** such as shared toast handling across apps
+
+For shared state primitives and shared TypeScript interfaces, use [`@tumaet/prompt-shared-state`](https://github.com/prompt-edu/prompt-shared-state).
+
+---
+
+## Package
+
+`@tumaet/prompt-ui-components` provides:
+- **36+ shadcn/ui base components** (buttons, dialogs, forms, tables, etc.)
+- **PromptTable** — advanced data table with sorting, filtering, pagination, row selection, and URL-synced state
+- **MinimalTiptapEditor** — rich text editor with toolbar, code highlighting, image support, and link management
+- **Custom components** — date pickers, multi-select, management page headers, score level selectors, and more
+
+---
+
+## Prerequisites
+
+This project uses **Yarn 4** as specified in the `packageManager` field of each `package.json`. To work with this repository, enable Corepack, which will automatically use the correct Yarn version.
+
+```bash
+corepack enable
+```
+
+Corepack is included by default with Node.js 16.9+ and 14.19+. If you see an error like:
+
+```text
+error This project's package.json defines "packageManager": "yarn@4.13.0". However the current global version of Yarn is 1.22.22.
+```
+
+Run `corepack enable` to fix it.
+
+---
+
+## Development
+
+### Building Locally
+
+```bash
+yarn install
+yarn build
+```
+
+### Linting
+
+```bash
+# From within the package directory
+yarn lint
+```
+
+### Testing Before Release
+
+```bash
+yarn build
+```
+
+---
+
+## Publishing Packages
+
+The package is published to npm when you create a GitHub release.
+
+### 1. Update Package Version
+
+Ensure `package.json` has the version number matching your intended release tag.
+
+```bash
+yarn version patch   # 1.2.3 -> 1.2.4
+# or: yarn version minor  (1.2.3 -> 1.3.0)
+# or: yarn version major  (1.2.3 -> 2.0.0)
+```
+
+Or edit the `package.json` file manually.
+
+### 2. Create a GitHub Release
+
+1. Go to the [Releases page](../../releases)
+2. Click **"Create a new release"**
+3. Create a new tag with the format `v{version}` (for example, `v1.2.3`)
+4. Set the release title and add release notes
+5. Click **"Publish release"**
+
+### 3. Automated Publishing
+
+Once you publish the release, the GitHub Actions workflow:
+
+1. **Validates** that `package.json` matches the release tag
+2. **Builds** the package
+3. **Publishes** `@tumaet/prompt-ui-components` to npm
+
+If there is a version mismatch, the workflow fails with a clear error.
+
+---
+
+## Package Information
+
+| Package | Latest Version | Description |
+|---|---|---|
+| [@tumaet/prompt-ui-components](https://www.npmjs.com/package/@tumaet/prompt-ui-components) | ![npm](https://img.shields.io/npm/v/@tumaet/prompt-ui-components) | Reusable React UI components |

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@tumaet/prompt-ui-components",
-  "version": "1.0.10",
+  "version": "1.0.11",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/ls1intum/prompt-lib.git"
+    "url": "git+https://github.com/prompt-edu/prompt-lib.git"
   },
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -66,39 +66,39 @@
     "@tiptap/pm": "^2.27.2",
     "@tiptap/react": "^2.27.2",
     "@tiptap/starter-kit": "^2.27.2",
-    "@tumaet/prompt-shared-state": "^1.0.8",
+    "@tumaet/prompt-shared-state": "^1.0.13",
     "class-variance-authority": "^0.7.1",
     "clsx": "^2.1.1",
     "cmdk": "1.1.1",
     "date-fns": "^4.1.0",
     "highlight.js": "^11.11.1",
     "lowlight": "^3.3.0",
-    "lucide-react": "^1.0.1",
-    "postcss": "^8.5.8",
-    "postcss-preset-env": "^11.2.0",
-    "react": "^19.2.4",
+    "lucide-react": "^1.8.0",
+    "postcss": "^8.5.10",
+    "postcss-preset-env": "^11.2.1",
+    "react": "^19.2.5",
     "react-day-picker": "8.10.1",
-    "react-dom": "^19.2.4",
-    "react-hook-form": "^7.72.0",
-    "react-medium-image-zoom": "^5.4.1",
-    "react-router-dom": "^7.13.2",
-    "recharts": "^3.8.0",
+    "react-dom": "^19.2.5",
+    "react-hook-form": "^7.72.1",
+    "react-medium-image-zoom": "^5.4.3",
+    "react-router-dom": "^7.14.2",
+    "recharts": "^3.8.1",
     "sonner": "^2.0.7",
-    "tailwind-merge": "^2.6.1",
+    "tailwind-merge": "^3.5.0",
     "tsc-alias": "^1.8.16",
     "typescript": "^5.9.3"
   },
   "devDependencies": {
-    "@eslint/compat": "^2.0.3",
+    "@eslint/compat": "^2.0.5",
     "@types/react": "^19.2.14",
     "@typescript-eslint/eslint-plugin": "^8.57.1",
     "@typescript-eslint/parser": "^8.57.1",
-    "eslint": "^10.1.0",
+    "eslint": "^10.2.1",
     "eslint-plugin-prettier": "^5.5.5",
     "eslint-plugin-react": "^7.37.5",
-    "eslint-plugin-react-hooks": "^7.0.1",
+    "eslint-plugin-react-hooks": "^7.1.1",
     "postcss-cli": "^11.0.1",
-    "prettier": "^3.8.1"
+    "prettier": "^3.8.3"
   },
   "resolutions": {
     "tar": "^7.5.13"

package/readme.md

@@ -1,36 +0,0 @@
-# prompt-ui-components
-
-A shared library for the **AET Prompt2** system that provides common UI components.
-
-These components are built using [shadcn/ui](https://ui.shadcn.dev/) and are maintained centrally to enable loading via **Module Federation** as a **singleton**.  
-This ensures:
-- A **consistent UI experience** across microfrontends
-- **Reduced bundle size** by avoiding duplicate component loading
-- **Unified UI state management** (e.g., for global toast notifications)
-
-## Overview
-
-The **prompt-ui-components-lib** package is designed to allow multiple microfrontends to share:
-- **Common, reusable UI components** with a unified look and feel
-- **Shared UI state**, such as toasts and modals, across independently deployed apps
-
-By using this library, all microfrontends rely on the same component instances and styling, preventing UI inconsistencies and improving maintainability.
-
-## Features
-
-- **Reusable UI Components**: Built on shadcn/ui, styled and configured for the Prompt2 system
-- **Shared UI State**: Centralized management for features like toast notifications
-- **Module Federation Ready**: Components are loaded as a singleton, preventing duplication
-- **Consistent Design System**: Ensures the same visual language across all microfrontends
-
-## Installation
-
-Install the package with your preferred package manager:
-
-```bash
-# Using Yarn
-yarn add @tumaet/prompt-ui-components-lib
-
-# Or using npm
-npm install @tumaet/prompt-ui-components-lib
-```