@api-client/ui 0.5.38 → 0.5.40

package/.github/instructions/lit-best-practices.instructions.md

@@ -1,90 +0,0 @@
----
-applyTo: "src/{elements,md,styles}/**,demo/**"
----
-
-# Lit Element Best Practices
-
-You are an expert developer in web components using the Lit library and Material Design version 3, focusing on best practices, accessibility, and responsive design.
-
-## Key Principles
-
-- Comply with web elements authoring standards when designing a web component.
-- Use accessibility best practices to produce semantically relevant web components.
-- Prioritize web standards over custom implementation.
-- Prioritize APIs that are passing the Web Platform Baseline
-- Minimize external dependencies, but also balance between custom code and widely known and trusted dependencies.
-- Everything must be ES compliant. Use the appropriate standards for module imports.
-
-## Lit Web Components
-
-- Document public properties and public function for authors to understand what these properties and functions do.
-- Ensure the appropriate aria roles are applied to each element.
-- Document all events and their structure (for custom events).
-- Prioritize well-known events (like change, select) over custom events.
-- Provide examples of usage when producing component documentation.
-- Prioritize native elements over custom elements whenever possible.
-- Prioritize composition over attribute passed configuration (a dropdown should have a semantic HTML structure and not auto-generated structure from a complex configuration object).
-- Think of other use-cases and how the custom element can scale for future use cases.
-- Reuse existing components whenever possible.
-- Prefer to put lifecycle methods after the constructor and before the render and other methods.
-- Put render methods at the end of the class.
-- Use `@property` decorator for public properties and `@state` decorator for private properties.
-- Use `@query` decorator for querying elements in the shadow DOM.
-- Use `@queryAssignedElements` decorator for querying slotted elements.
-- Boolean properties should be initialized to `false` in the constructor.
-- Use `@eventOptions` decorator to specify event options like `capture`, `passive`, and `once`.
-- Use `@queryAsync` decorator for querying elements that may not be immediately available in the DOM.
-- Use `@state` decorator for properties that are internal to the component and should not be exposed to the outside world.
-- Avoid passing complex objects as properties. Instead, use simple types like `string`, `number`, or `boolean` and handle complex logic internally.
-- Use lifecycle methods like `connectedCallback`, `disconnectedCallback`, and `update` to manage component state and behavior.
-- Use `willUpdate` method to perform actions before the component updates, such as validating properties or preparing data.
-- Place the component definition under the `internals/` directory of a component folder. The components registration should be done in the component file in the main component directory.
-- Place the base material components under the `src/md/` directory.
-- Place composite components under the `src/elements/` directory.
-
-## CSS and Styling
-
-- Prioritize native CSS over JavaScript implementation. Use Web Platform Baseline even if the editor says it's not supported.
-- Use anchoring and popover API whenever possible and applicable over JavaScript positioning.
-- Place lit component styles in a separate file with the `.styles.ts` extension.
-- Add styles to the component registration class, not the base class.
-- Declare the `part` attributes to expose custom styling.
-- When working on base components, use CSS variables to allow customization of the component styles.
-- Define component states via the `internals.states.add("--state-name")` method. These states can be used as `component-name:state(state-name) {}` in the CSS.
-
-## Error handling
-
-- Components either communicate errors through rendering them internally or dispatch an error event with the error details to the parent component or application.
-- Prefer error states defined on the element internals over custom error styling.
-
-## Naming Convention
-
-- Follow web authoring standards as closely as possible.
-- Minimize the the of "-" in attribute and event names
-- Use camelCase for properties and methods.
-- Do not prefix private or protected properties and methods with an underscore. Use the typescript `private` and `protected` keywords to indicate visibility.
-
-## Testing
-
-- Use @open-wc/testing library.
-- Always add accessibility tests.
-- Create fixtures for different states of a component.
-- To run tests for a specific file, use the `--files` option in the test command. For example:
-
-  ```bash
-  npm test -- --files=".tmp/test/**/[test file name].test.js"
-  ```
-  
-- Prefer the Assert API over the Expect API for assertions. The Assert API is more performant and provides better error messages.
-- When updating an element's property, await for the update to complete using `await element.updateComplete` before making assertions. This ensures that the component has fully rendered before checking its state.
-
-## Component Demoing
-
-- Always produce a demo page under the demo/ directory.
-- Use the `DemoPage` class to bootstrap the demo page.
-- Use material styles with the demo page. Minimize custom styling.
-- Try to render each state separately and minimize the use of complex configurations.
-- Start with simple states and progressively enhance the demo with more complex configurations.
-- If a component produces output, ensure that the demo page shows the output in a readable format. Use one output per component.
-- Document the states in a way that is obvious to the user. Use headings and paragraphs to explain the states.
-- Due to the nature how the demo pages are processed, ensure that typescript files that belong to the demo page are imported from the `/.tmp/demo/` directory. This is done automatically by the build process. Imports inside the typescript file should reference files from the `src/` folder directly.

package/.github/release.yml

@@ -1,14 +0,0 @@
-changelog:
-  exclude:
-    labels:
-      - ignore-for-release
-  categories:
-    - title: 🏕 Features
-      labels:
-        - '*'
-      exclude:
-        labels:
-          - dependencies
-    - title: 👒 Dependencies
-      labels:
-        - dependencies

package/.github/stale.yml

@@ -1,23 +0,0 @@
-# Number of days of inactivity before an issue becomes stale
-daysUntilStale: 45
-# Number of days of inactivity before a stale issue is closed
-daysUntilClose: 7
-# Issues with these labels will never be considered stale
-exemptLabels:
-   - bug
-   - fixme/bug
-   - fixme/security
-   - blocked
-   - needs-review
-   - roadmap
-# Label to use when marking an issue as stale
-staleLabel: stale
-# Comment to post when marking an issue as stale. Set to `false` to disable
-markComment: >
-  This issue has been automatically marked as stale because it has not had
-  recent activity and is not currently prioritized. It will be closed
-  in a week if no further activity occurs :)
-# Comment to post when closing a stale issue. Set to `false` to disable
-closeComment: >
-  If you still think this issue is relevant, please ping a maintainer or
-  leave a comment!

package/.github/workflows/auto-release.yml

@@ -1,182 +0,0 @@
-name: Auto Release
-
-on:
-  push:
-    branches:
-      - main
-
-env:
-  FORCE_COLOR: 1
-
-jobs:
-  test:
-    name: Test
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 24
-          cache: 'npm'
-
-      - uses: google/wireit@setup-github-actions-caching/v2
-      
-      - name: Install dependencies
-        run: npm ci
-      
-      - name: Install playwright browsers
-        run: npx playwright install --with-deps
-      
-      - name: Run tests
-        run: npm test
-
-  determine-release:
-    name: Determine Release Type
-    needs: test
-    runs-on: ubuntu-latest
-    outputs:
-      should-release: ${{ steps.release-check.outputs.should-release }}
-      release-type: ${{ steps.release-check.outputs.release-type }}
-      new-version: ${{ steps.release-check.outputs.new-version }}
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-          token: ${{ secrets.GITHUB_TOKEN }}
-      
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 24
-          cache: 'npm'
-      
-      - name: Install dependencies
-        run: npm ci
-      
-      - name: Determine release type
-        id: release-check
-        run: |
-          # Get the last tag
-          LAST_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "v0.0.0")
-          echo "Last tag: $LAST_TAG"
-          
-          # Get commits since last tag
-          COMMITS=$(git log --pretty=format:"%s" ${LAST_TAG}..HEAD)
-          echo "Commits since last tag:"
-          echo "$COMMITS"
-          
-          # Check if there are any commits to release
-          if [ -z "$COMMITS" ]; then
-            echo "No new commits since last tag"
-            echo "should-release=false" >> $GITHUB_OUTPUT
-            exit 0
-          fi
-          
-          # Determine release type based on commit messages
-          RELEASE_TYPE="patch"
-          
-          # Check for breaking changes
-          if echo "$COMMITS" | grep -q "BREAKING CHANGE" || echo "$COMMITS" | grep -q '!:'; then
-            RELEASE_TYPE="major"
-          # Check for new features
-          elif echo "$COMMITS" | grep -q "^feat"; then
-            RELEASE_TYPE="minor"
-          fi
-          
-          echo "Release type: $RELEASE_TYPE"
-          
-          # Calculate new version
-          CURRENT_VERSION=$(node -p "require('./package.json').version")
-          echo "Current version: $CURRENT_VERSION"
-          
-          # Use semver to calculate new version
-          NEW_VERSION=$(node -e "
-            const SemVer = require('@pawel-up/semver/classes/semver.js').default || require('@pawel-up/semver/classes/semver.js');
-            const ver = new SemVer('$CURRENT_VERSION');
-            ver.inc('$RELEASE_TYPE');
-            console.log(ver.format());
-          " CURRENT_VERSION="$CURRENT_VERSION" RELEASE_TYPE="$RELEASE_TYPE")
-          
-          echo "New version: $NEW_VERSION"
-          
-          echo "should-release=true" >> $GITHUB_OUTPUT
-          echo "release-type=$RELEASE_TYPE" >> $GITHUB_OUTPUT
-          echo "new-version=$NEW_VERSION" >> $GITHUB_OUTPUT
-
-  release:
-    name: Create Release
-    needs: [test, determine-release]
-    if: needs.determine-release.outputs.should-release == 'true'
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-      issues: write
-      pull-requests: write
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-          token: ${{ secrets.GITHUB_TOKEN }}
-      
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 24
-          cache: 'npm'
-          registry-url: 'https://registry.npmjs.org'
-      
-      - name: Install dependencies
-        run: npm ci
-      
-      - name: Update version
-        run: |
-          # Update package.json version
-          NEW_VERSION="${{ needs.determine-release.outputs.new-version }}"
-          npm version $NEW_VERSION --no-git-tag-version
-          git add package.json
-          
-          # Commit version bump
-          # git config --local user.email "action@github.com"
-          # git config --local user.name "GitHub Action"
-          # git add package.json
-          # git commit -m "chore: bump version to $NEW_VERSION"
-          # git push
-
-      - uses: qoomon/actions--create-commit@v1
-        id: commit
-        with:
-          message: "chore: bump version to ${{ needs.determine-release.outputs.new-version }}"
-          skip-empty: true
-      
-      - run: git push
-      
-      - name: Build
-        run: npm run build
-      
-      - name: Generate changelog
-        id: changelog
-        run: |
-          echo "changelog<<EOF" >> $GITHUB_OUTPUT
-          npx conventional-changelog-cli@latest release --preset conventionalcommits --release-count 1 >> $GITHUB_OUTPUT
-          echo "EOF" >> $GITHUB_OUTPUT
-      
-      - name: Create Release
-        uses: softprops/action-gh-release@v2
-        with:
-          tag_name: v${{ needs.determine-release.outputs.new-version }}
-          body: ${{ steps.changelog.outputs.changelog }}
-          draft: false
-          prerelease: false
-          generate_release_notes: false
-      
-      - name: Publish to npm
-        run: npm publish --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} 

package/.github/workflows/release.yml

@@ -1,82 +0,0 @@
-name: Manual Release
-
-on:
-  push:
-    tags:
-      - 'v*'
-
-env:
-  FORCE_COLOR: 1
-
-jobs:
-  test:
-    name: Test
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 24
-          cache: 'npm'
-      
-      - name: Install dependencies
-        run: npm ci
-      
-      - name: Install playwright browsers
-        run: npx playwright install --with-deps
-      
-      - name: Run tests
-        run: npm test
-
-  release:
-    name: Create Release
-    needs: test
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-      issues: write
-      pull-requests: write
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-          token: ${{ secrets.GITHUB_TOKEN }}
-      
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 24
-          cache: 'npm'
-          registry-url: 'https://registry.npmjs.org'
-      
-      - name: Install dependencies
-        run: npm ci
-      
-      - name: Build
-        run: npm run build
-      
-      - name: Generate changelog
-        id: changelog
-        run: |
-          echo "changelog<<EOF" >> $GITHUB_OUTPUT
-          npx conventional-changelog-cli@latest release --preset conventionalcommits --release-count 1 >> $GITHUB_OUTPUT
-          echo "EOF" >> $GITHUB_OUTPUT
-      
-      - name: Create Release
-        uses: softprops/action-gh-release@v2
-        with:
-          body: ${{ steps.changelog.outputs.changelog }}
-          draft: false
-          prerelease: false
-          generate_release_notes: false
-      
-      - name: Publish to npm
-        run: npm publish --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} 

package/.prettierrc.js

@@ -1,14 +0,0 @@
-/**
- * @see https://prettier.io/docs/configuration
- * @type {import("prettier").Config}
- */
-export default {
-  trailingComma: 'es5',
-  semi: false,
-  singleQuote: true,
-  useTabs: false,
-  quoteProps: 'consistent',
-  bracketSpacing: true,
-  arrowParens: 'always',
-  printWidth: 120,
-}

package/.vscode/settings.json

@@ -1,18 +0,0 @@
-{
-  "cSpell.words": [
-    "debouncer",
-    "iconbutton",
-    "itemschange",
-    "openentity",
-    "popovertarget",
-    "querycomplete",
-    "selectedcontent",
-    "startactivity",
-    "startactivityforresult",
-    "typescale"
-  ],
-  "vscode-wtr-runner.testRunnerCommand": "npm run tsc:all && npx wtr --playwright --browsers \"chromium\"",
-  "geminicodeassist.customCommands": {
-    "add-comments": "add comments to my code. add examples whenever reasonable. focus on another developer understanding what the function is about. don't forget about class fields."
-  }
-}

package/RELEASE.md

@@ -1,163 +0,0 @@
-# Release Guide
-
-This project uses an **automated release system** with conventional commits and GitHub Actions. Releases are automatically created when changes are merged to the main branch.
-
-## 🚀 Automated Releases (Recommended)
-
-### How It Works
-
-1. **Push to main branch** (usually via PR merge)
-2. **Tests run automatically** to ensure quality
-3. **System analyzes commit messages** since the last release
-4. **Release type is determined automatically:**
-   - `major` - if commits contain "breaking:" or "!:"
-   - `minor` - if commits contain "feat:" (new features)
-   - `patch` - for all other changes (bug fixes, docs, etc.)
-5. **Release is created automatically** with changelog and npm publish
-
-### Commit Message Examples
-
-```bash
-# Major release (breaking changes)
-git commit -m "feat!: remove deprecated API"
-git commit -m "feat: new system
-
-BREAKING CHANGE: Old methods no longer work"
-
-# Minor release (new features)
-git commit -m "feat: add OAuth2 support"
-git commit -m "feat(auth): implement JWT tokens"
-
-# Patch release (bug fixes, docs, etc.)
-git commit -m "fix: resolve memory leak"
-git commit -m "docs: update API documentation"
-git commit -m "chore: update dependencies"
-```
-
-### What Happens Automatically
-
-1. ✅ Tests run to ensure everything works
-2. ✅ Version is bumped in `package.json`
-3. ✅ Changes are committed with conventional commit message
-4. ✅ Git tag is created (e.g., `v1.2.3`)
-5. ✅ GitHub release is created with automated changelog
-6. ✅ Package is published to npm
-
-## 🔧 Manual Releases (Fallback)
-
-If you need to create a release manually (e.g., for hotfixes or special releases):
-
-### Option 1: Use the release script
-
-```bash
-# Create a patch release (bug fixes)
-npm run release:patch
-
-# Create a minor release (new features)
-npm run release:minor
-
-# Create a major release (breaking changes)
-npm run release:major
-
-# Or use the default (patch)
-npm run release
-```
-
-### Option 2: Manual tag creation
-
-```bash
-npm run build
-# Update version in package.json
-npm version patch --no-git-tag-version
-
-# Commit the change
-git add package.json
-git commit -m "chore: bump version to X.Y.Z"
-
-# Create and push tag
-git tag vX.Y.Z
-git push origin main
-git push origin vX.Y.Z
-```
-
-## 📋 Conventional Commits
-
-The release system uses conventional commits to generate changelogs. Your commit messages should follow this format:
-
-```plain
-type(scope): description
-
-[optional body]
-
-[optional footer]
-```
-
-### Commit Types
-
-- `feat`: New features (triggers minor release)
-- `fix`: Bug fixes (triggers patch release)
-- `docs`: Documentation changes
-- `style`: Code style changes (formatting, etc.)
-- `refactor`: Code refactoring
-- `test`: Adding or updating tests
-- `chore`: Maintenance tasks
-
-### Breaking Changes
-
-To indicate a breaking change, use either:
-
-- `!:` in the commit message: `feat!: remove deprecated API`
-- `BREAKING CHANGE:` in the commit body:
-
-  ```plain
-  feat: new authentication system
-  
-  BREAKING CHANGE: Old auth methods are no longer supported
-  ```
-
-## 🔄 Workflow Comparison
-
-| Aspect | Automated Release | Manual Release |
-|--------|------------------|----------------|
-| **Trigger** | Push to main | Tag push or script |
-| **Release Type** | Auto-detected from commits | Manually specified |
-| **Effort** | Zero - fully automated | Manual intervention |
-| **Use Case** | Regular development flow | Hotfixes, special releases |
-
-## 🛠️ Configuration
-
-The release system is configured in:
-
-- `.github/workflows/auto-release.yml` - Automated release workflow
-- `.github/workflows/release.yml` - Manual release workflow (fallback)
-- `scripts/release.js` - Manual release automation script
-- `commitlint.config.js` - Conventional commits configuration
-- `package.json` - Version management and scripts
-
-## 🚨 Troubleshooting
-
-### Common Issues
-
-1. **No release created**: Check if commits follow conventional format
-2. **Wrong release type**: Ensure commit messages use correct prefixes
-3. **Tests failing**: Release won't proceed if tests fail
-4. **Permission denied**: Ensure GitHub token has write permissions
-
-### Debugging
-
-The automated workflow logs will show:
-
-- Last tag found
-- Commits since last tag
-- Determined release type
-- Calculated new version
-
-### Rollback
-
-If you need to rollback a release:
-
-1. Delete the tag locally: `git tag -d vX.Y.Z`
-2. Delete the tag on GitHub: `git push origin :refs/tags/vX.Y.Z`
-3. Revert the version in `package.json`
-4. Commit the revert: `git commit -m "chore: revert version to X.Y.Z"`
-5. Push the changes: `git push origin main`