Compare commits
76 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 1445fff739 | |||
| 5cf365f354 | |||
| f73ce4095c | |||
| 1484d53f8c | |||
| 0e99c9c59e | |||
| 644e61aab0 | |||
| 4c2a104af7 | |||
| 95dd8b9dc2 | |||
| 8b01c04a4c | |||
| 981f56a693 | |||
| f6bd04f354 | |||
| 8da8a26a90 | |||
| 42fe5afe52 | |||
| 437c020566 | |||
| b863ed4d51 | |||
| 368642345d | |||
| 43bc31c8b4 | |||
| 357049aa7b | |||
| d85ef5621c | |||
| faac180212 | |||
| 76d8a45f37 | |||
| d68d322df6 | |||
| 113c951028 | |||
| 2a4ab676ec | |||
| c0a04f505e | |||
| a63006bb07 | |||
| f8e678215d | |||
| f745f8ec1e | |||
| 33502a6d99 | |||
| 1306ee9518 | |||
| e37546cab1 | |||
| 88c3233fd1 | |||
| 02f3047080 | |||
| d4012589e6 | |||
| 8ac67fa60c | |||
| 981490c152 | |||
| 99b2a0f0c5 | |||
| 7ead494765 | |||
| 342b6f6c57 | |||
| 66ca63b2be | |||
| e8325f722f | |||
| 7c1a91937a | |||
| 7ac3289bb7 | |||
| 19bdbd1b9a | |||
| 24363cd2ac | |||
| e19ca5bff1 | |||
| 05897d4370 | |||
| 7a3a28d87f | |||
| 240cded8a9 | |||
| 31e241f052 | |||
| de579682a0 | |||
| 9acbd5046c | |||
| 8d63c88e69 | |||
| cffb0af60e | |||
| 857b7a127a | |||
| 66b24ece48 | |||
| 0cc3b466e0 | |||
| f1e03b31a1 | |||
| 4e12d596d6 | |||
| fa97f89afb | |||
| 0718bee185 | |||
| 1a53107450 | |||
| ab82cc6fd3 | |||
| 8e51f144e1 | |||
| f292e22301 | |||
| 2eb194c001 | |||
| f4e367987a | |||
| 08aa4b5e15 | |||
| b1676482f0 | |||
| e46cd6e488 | |||
| edd2fdd3fb | |||
| a4a0c1462b | |||
| 196e63c08e | |||
| 518ac1d59d | |||
| ad699dc69a | |||
| a8e247d288 |
151
CHANGELOG.md
151
CHANGELOG.md
@@ -11,6 +11,157 @@ Sections:
|
||||
|
||||
---
|
||||
|
||||
## [0.7.0] - 2026-01-20
|
||||
|
||||
### Added
|
||||
- Options dialog (gear icon) for the Bahmcloud Store integration.
|
||||
- Optional GitHub token can now be set, changed or removed via the Home Assistant UI.
|
||||
|
||||
### Fixed
|
||||
- Fixed missing options flow when clicking the integration settings button.
|
||||
|
||||
## [0.6.9] – 2026-01-19
|
||||
### Added
|
||||
- New Home Assistant **GUI setup** (Config Flow) – no YAML configuration required.
|
||||
- Optional **GitHub Token** support to increase API limits (up to 5000 req/h).
|
||||
Configurable via *Integration → Options*.
|
||||
- Clear setup guidance and warning about GitHub rate limits.
|
||||
- Automatic detection and warning if YAML setup is still present (ignored safely).
|
||||
|
||||
### Changed
|
||||
- **store.yaml** URL is now fixed to the official Bahmcloud Store index:
|
||||
https://git.bahmcloud.de/bahmcloud/ha_store/raw/branch/main/store.yaml
|
||||
- Installation workflow fully aligned with standard HA integrations.
|
||||
- Update platform migrated to `async_setup_entry`.
|
||||
|
||||
### Fixed
|
||||
- Minor stability and persistence improvements in startup sequence.
|
||||
- Prevented duplicate background initialization when HA reloads the integration.
|
||||
|
||||
### Notes
|
||||
- To enable extended GitHub access, create a fine-grained personal access token
|
||||
(read-only) at https://github.com/settings/tokens and add it via the integration options.
|
||||
|
||||
## 0.6.8 – Performance & Cache Stabilization (2026-01-19)
|
||||
|
||||
### Fixed
|
||||
- Fixed excessive GitHub API requests causing rate limiting
|
||||
- Fixed missing persistence of repository versions and metadata
|
||||
- Fixed background enrichment re-running after Home Assistant restart
|
||||
|
||||
### Changed
|
||||
- Repository metadata (versions, README, descriptions) is now fetched once in the background
|
||||
- Cached data is reused and only refreshed on explicit user interaction
|
||||
- Improved separation between startup refresh and on-demand updates
|
||||
|
||||
### Improved
|
||||
- Significantly reduced Home Assistant startup time
|
||||
- Greatly reduced GitHub API usage
|
||||
- More reliable version selection for GitHub and HACS repositories
|
||||
|
||||
### Notes
|
||||
- Background tasks may still appear in DEBUG logs (expected behavior)
|
||||
- No functional UI changes in this release
|
||||
|
||||
## [0.6.7] - 2026-01-19
|
||||
|
||||
### Fixed
|
||||
- Repository metadata loaded on demand is now persisted and restored after Home Assistant restart.
|
||||
- Background enrichment reliably updates latest versions and descriptions for HACS repositories.
|
||||
- Cached repository data is correctly restored on startup for non-installed repositories.
|
||||
|
||||
### Changed
|
||||
- Repository details are only considered fully enriched once latest version information is available.
|
||||
- Improved reliability of background cache synchronization without impacting startup performance.
|
||||
|
||||
## [0.6.6] - 2026-01-18
|
||||
|
||||
### Added
|
||||
- Source filter to limit repositories by origin: BCS Official, HACS, or Custom.
|
||||
- Visual source badges for repositories (BCS Official, HACS, Custom).
|
||||
- Restored HACS enable/disable toggle in the Store UI.
|
||||
|
||||
### Changed
|
||||
- HACS repositories now display human-readable names and descriptions based on official HACS metadata.
|
||||
- Improved Store usability on mobile devices by fixing back navigation from repository detail view.
|
||||
|
||||
### Fixed
|
||||
- Fixed missing HACS toggle after UI updates.
|
||||
- Fixed mobile browser back button exiting the Store instead of returning to the repository list.
|
||||
|
||||
## [0.6.5] - 2026-01-18
|
||||
|
||||
### Added
|
||||
- Separate handling of HACS official repositories with an enable/disable toggle in the Store UI.
|
||||
- HACS repositories are now loaded independently from the main store index.
|
||||
|
||||
### Changed
|
||||
- Store index can remain minimal and curated; HACS repositories are no longer required in store.yaml.
|
||||
- Improved Store performance and clarity by clearly separating repository sources.
|
||||
|
||||
### Fixed
|
||||
- Browser cache issues resolved by proper panel cache-busting for UI updates.
|
||||
|
||||
### Internal
|
||||
- No changes to install, update, backup, or restore logic.
|
||||
- Fully backward compatible with existing installations and configurations.
|
||||
|
||||
## [0.6.4] - 2026-01-18
|
||||
|
||||
### Fixed
|
||||
- Fixed long Home Assistant startup times caused by background repository enrichment running too early.
|
||||
|
||||
### Changed
|
||||
- Background repository enrichment is now started only after Home Assistant has fully started.
|
||||
- Repository cache updates now run fully asynchronous without blocking Home Assistant startup.
|
||||
|
||||
### Internal
|
||||
- Improved alignment with Home Assistant startup lifecycle.
|
||||
- No functional changes to store behavior or UI.
|
||||
|
||||
## [0.6.3] - 2026-01-18
|
||||
|
||||
### Changed
|
||||
- Improved Store performance for large indexes by avoiding full metadata enrichment during list refresh.
|
||||
- Repository details are loaded on demand, reducing initial load time and network requests.
|
||||
- Index refresh is skipped when the index content has not changed.
|
||||
|
||||
## [0.6.2] - 2026-01-18
|
||||
|
||||
### Added
|
||||
- Selectable install/update version per repository (install older releases/tags to downgrade when needed).
|
||||
- New API endpoint to list available versions for a repository: `GET /api/bcs/versions?repo_id=...`.
|
||||
|
||||
## [0.6.1] - 2026-01-18
|
||||
|
||||
### Fixed
|
||||
- Restored integrations now correctly report the restored version instead of the latest installed version.
|
||||
- Update availability is correctly recalculated after restoring a backup, allowing updates to be applied again.
|
||||
- Improved restore compatibility with backups created before version metadata was introduced.
|
||||
|
||||
## [0.6.0] - 2026-01-18
|
||||
|
||||
### Added
|
||||
- Restore feature with selection of the last available backups (up to 5 per domain).
|
||||
- New API endpoints to list and restore backups:
|
||||
- `GET /api/bcs/backups?repo_id=...`
|
||||
- `POST /api/bcs/restore?repo_id=...&backup_id=...`
|
||||
|
||||
### Safety
|
||||
- Restoring a backup triggers a “restart required” prompt to apply the recovered integration state.
|
||||
|
||||
### Notes
|
||||
- This is a major release milestone consolidating install/update/uninstall, backup/rollback, and restore workflows.
|
||||
|
||||
## [0.5.11] - 2026-01-18
|
||||
|
||||
### Added
|
||||
- Automatic backup of existing custom components before install or update.
|
||||
- Backup retention with a configurable limit per domain.
|
||||
|
||||
### Safety
|
||||
- Automatic rollback is triggered if an install or update fails after a backup was created.
|
||||
|
||||
## [0.5.10] - 2026-01-17
|
||||
|
||||
### Added
|
||||
|
||||
51
README.md
51
README.md
@@ -1,3 +1,50 @@
|
||||
# bahmcloud_store
|
||||
# Bahmcloud Store (BCS) for Home Assistant
|
||||
|
||||
Bahmcloud Store for installing costum_components to Homeassistant
|
||||
Bahmcloud Store (BCS) is a provider-neutral store for Home Assistant custom integrations.
|
||||
It allows you to browse, install, update, downgrade, uninstall and restore integrations
|
||||
directly from the Home Assistant UI.
|
||||
|
||||
This README is intended for **end users**.
|
||||
|
||||
---
|
||||
|
||||
## Installation
|
||||
|
||||
### Option A: Home Assistant OS / Supervised (Add-on – recommended)
|
||||
|
||||
1. Open **Settings → Add-ons → Add-on Store**
|
||||
2. Add the Bahmcloud Add-on repository
|
||||
`https://git.bahmcloud.de/bahmcloud/addons`
|
||||
3. Install **Bahmcloud Store Installer**
|
||||
4. Start the add-on
|
||||
5. Restart Home Assistant
|
||||
|
||||
Installed to:
|
||||
/config/custom_components/bahmcloud_store
|
||||
|
||||
---
|
||||
|
||||
### Option B: Manual Installation (Container / Core)
|
||||
|
||||
1. Download the latest release
|
||||
2. Copy `custom_components/bahmcloud_store` to:
|
||||
/config/custom_components/bahmcloud_store
|
||||
3. Restart Home Assistant
|
||||
|
||||
---
|
||||
|
||||
## Repository Sources
|
||||
|
||||
- **BCS Official**
|
||||
- **HACS**
|
||||
- **Custom**
|
||||
|
||||
---
|
||||
|
||||
## Documentation
|
||||
|
||||
Developer documentation:
|
||||
https://git.bahmcloud.de/bahmcloud/bahmcloud_store/src/branch/main/README_DEVELOPER.md
|
||||
|
||||
Full technical documentation:
|
||||
https://git.bahmcloud.de/bahmcloud/bahmcloud_store/src/branch/main/README_FULL.md
|
||||
|
||||
115
README_DEVELOPER.md
Normal file
115
README_DEVELOPER.md
Normal file
@@ -0,0 +1,115 @@
|
||||
# Bahmcloud Store – Developer Documentation
|
||||
|
||||
For contributors and maintainers.
|
||||
|
||||
## Architecture
|
||||
|
||||
Repositories:
|
||||
1) Installer Add-on (HAOS/Supervised) ```https://git.bahmcloud.de/bahmcloud/addons```
|
||||
2) Core Integration ```https://git.bahmcloud.de/bahmcloud/bahmcloud_store```
|
||||
3) Store Index (`store.yaml`) ```https://git.bahmcloud.de/bahmcloud/ha_store```
|
||||
|
||||
### Integration Layout
|
||||
|
||||
custom_components/bahmcloud_store/
|
||||
- __init__.py: setup, panel registration, schedule background after HA started
|
||||
- core.py: index merge, enrichment, install/update/uninstall, backups, restore, caching
|
||||
- providers.py: GitHub/GitLab/Gitea repo info + latest version helpers
|
||||
- metadata.py: read bcs.yaml / hacs.json / hacs.yaml
|
||||
- storage.py: persistent storage (installed, custom, repo cache, hacs cache)
|
||||
- views.py: HTTP API endpoints
|
||||
- update.py: UpdateEntity implementation
|
||||
- repairs.py: (optional) Repairs flow for restart
|
||||
- panel/: UI (panel.js, styles.css, etc.)
|
||||
- manifest.json
|
||||
|
||||
## Runtime Model
|
||||
|
||||
- RepoItem (merged)
|
||||
- Installed repos (storage)
|
||||
- Repo cache (persisted enrichment)
|
||||
- HACS meta cache (mapping owner/repo → name/description)
|
||||
|
||||
## Background
|
||||
|
||||
- Heavy work only after `homeassistant_started`
|
||||
- Refresh: if index unchanged → installed-only refresh + schedule enrichment
|
||||
- Opening a repo triggers `ensure_repo_details()` and persists to cache
|
||||
|
||||
## Providers
|
||||
|
||||
- GitHub: API/releases/tags/atom + raw readme
|
||||
- GitLab: API releases/tags + raw readme
|
||||
- Gitea: API releases/tags + raw readme
|
||||
- Custom: API or HTTPS Request to your Git Provider
|
||||
|
||||
## Metadata
|
||||
|
||||
- Prefer `bcs.yaml`, fallback `hacs.json` / `hacs.yaml`
|
||||
- Populate name/description/category/author/maintainer
|
||||
|
||||
## HTTP API (excerpt)
|
||||
|
||||
Base: /api/bcs
|
||||
|
||||
- GET /api/bcs
|
||||
- POST /api/bcs?action=refresh
|
||||
- GET /api/bcs/readme?repo_id=...
|
||||
- GET /api/bcs/versions?repo_id=...
|
||||
- POST /api/bcs/install?repo_id=...&version=...
|
||||
- POST /api/bcs/update?repo_id=...&version=...
|
||||
- POST /api/bcs/uninstall?repo_id=...
|
||||
- GET /api/bcs/backups?repo_id=...
|
||||
- POST /api/bcs/restore?repo_id=...&backup_id=...
|
||||
- (optional) POST/DELETE custom_repo
|
||||
|
||||
## Update Entities
|
||||
|
||||
- Unique id bcs:<repo_id>
|
||||
- Compare installed ref vs latest ref
|
||||
- Dispatcher signal on refresh/install/update
|
||||
|
||||
## Storage
|
||||
|
||||
- JSON in HA `.storage`
|
||||
- async read/write helpers
|
||||
- repo cache applied on startup
|
||||
|
||||
## Contributing to **BCS Official**
|
||||
|
||||
1) Add pull request to `https://git.bahmcloud.de/bahmcloud/ha_store` (with your integration added to) `store.yaml`)
|
||||
2) Add entry:
|
||||
```yaml
|
||||
- name: Your Integration Name
|
||||
url: https://your-git-hoster.com/your-org/your-repo
|
||||
category: Category (actually only "Integrations" are supported)
|
||||
```
|
||||
3) (Recommended) Add `bcs.yaml` to your repo:
|
||||
```yaml
|
||||
name: Your Integration Name
|
||||
description: One-liner for the store (optional, store information are also catched from git repository)
|
||||
category: Integrations (actually only supported)
|
||||
author: Your Name
|
||||
maintainer: Your Handle
|
||||
```
|
||||
4) Open PR; validation checks: reachable, has `custom_components/<domain>/manifest.json`, sensible metadata
|
||||
5) Merge → appears in **BCS Official** after refresh
|
||||
|
||||
## Coding Guidelines
|
||||
|
||||
- Async I/O, no blocking event loop
|
||||
- Respect provider rate limits
|
||||
- Clean logging around refresh/install/update/restore
|
||||
- Keep UI responsive; throttle updates
|
||||
|
||||
---
|
||||
|
||||
## Planed Features
|
||||
|
||||
- Add Downloads and install for category "Dashboard"
|
||||
- Add Downloads and install for category "Template"
|
||||
- Add Downloads and install for category "Theme"
|
||||
- Add Downloads and install for category "Blueprint"
|
||||
-
|
||||
|
||||
|
||||
217
README_FULL.md
Normal file
217
README_FULL.md
Normal file
@@ -0,0 +1,217 @@
|
||||
# Bahmcloud Store – Full User Guide
|
||||
|
||||
This guide explains **all features** of Bahmcloud Store (BCS) for Home Assistant.
|
||||
It is written for users and admins who want a complete, practical reference.
|
||||
|
||||
> BCS lets you install & manage custom integrations from **GitHub/GitLab/Gitea** and your own sources, with backups, restore, and version pinning.
|
||||
|
||||
---
|
||||
|
||||
## Contents
|
||||
- Concepts
|
||||
- Sources (BCS / HACS / Custom)
|
||||
- UI Overview
|
||||
- Finding Integrations
|
||||
- Installing
|
||||
- Selecting Versions / Downgrading
|
||||
- Updating
|
||||
- Uninstalling
|
||||
- Backups & Restore
|
||||
- Custom Repositories
|
||||
- HACS Repositories
|
||||
- Update Entities in Home Assistant
|
||||
- Background Caching & Performance
|
||||
- Restart Required
|
||||
- Troubleshooting
|
||||
- FAQ
|
||||
|
||||
---
|
||||
|
||||
## Concepts
|
||||
|
||||
- **Sources**:
|
||||
- **BCS Official** → entries from index (`store.yaml`) made and added from Bahmcloud
|
||||
- **HACS** → official HACS integrations list (toggleable)
|
||||
- **Custom** → manual entries you add locally
|
||||
- **Install location**: `/config/custom_components/<domain>`
|
||||
- **Backup**: BCS keeps pre‑update copies in `/config/.bcs_backups/<domain>/<timestamp>/`
|
||||
|
||||
---
|
||||
|
||||
## Sources (BCS / HACS / Custom)
|
||||
|
||||
Each repository card shows a **source badge**:
|
||||
- **BCS Official** – from Bahmcloud index
|
||||
- **HACS** – from HACS official list (enable with the toggle)
|
||||
- **Custom** – added by you
|
||||
|
||||
You can **filter by source** with the **Source** dropdown (All / BCS Official / HACS / Custom).
|
||||
|
||||
---
|
||||
|
||||
## UI Overview
|
||||
|
||||
Top bar:
|
||||
- **Search** (name/description)
|
||||
- **Source** filter (All/BCS Official/HACS/Custom)
|
||||
- **Category** filter (actually only Integrations are supported)
|
||||
- **State-Filter** filter (All/Installed/Not installed/Update available/Custom repos)
|
||||
- **Sort** (name (A-Z)/Updates first/Installed first)
|
||||
- **HACS official** toggle (on/off)
|
||||
|
||||
Repository card:
|
||||
- Name, description, badges (source, installed/update), category
|
||||
- Buttons: **Install / Update / Uninstall**
|
||||
- **Readme** expandable
|
||||
- **Open** to see details (available versions, metadata)
|
||||
|
||||
---
|
||||
|
||||
## Finding Integrations
|
||||
|
||||
1. Use **Search** to filter by keywords.
|
||||
2. Combine with **Category** and **Source**.
|
||||
3. Sort to surface desired results.
|
||||
|
||||
Descriptions and latest versions are filled progressively by a background process; opening a repo loads details on demand.
|
||||
|
||||
---
|
||||
|
||||
## Installing
|
||||
|
||||
1. Open a repository.
|
||||
2. Optionally select **Install version** (default: **Latest**).
|
||||
3. Click **Install** and wait for confirmation.
|
||||
4. Follow the **Restart required** prompt. (or use restart toggle in HomeAssistant Settings)
|
||||
|
||||
**What happens internally**
|
||||
- BCS downloads the repository ZIP for the selected version (release/tag/branch).
|
||||
- It extracts all integrations found under `custom_components/<domain>` and deploys them.
|
||||
- It saves the **installed version (ref)** to track updates reliably, even if the repo’s own `manifest.json` is wrong/outdated.
|
||||
|
||||
---
|
||||
|
||||
## Selecting Versions / Downgrading
|
||||
|
||||
- Use the **Install version** dropdown in the detail view.
|
||||
- Choose **Latest** or a previous **release/tag**.
|
||||
- Installing a chosen ref **pins** the integration to that ref (no surprise updates).
|
||||
- You can upgrade again later by selecting **Latest** and clicking **Update**.
|
||||
|
||||
---
|
||||
|
||||
## Updating
|
||||
|
||||
- The **Update** button appears when `latest_version` differs from your **installed version (ref)**.
|
||||
- Updates are also available via **Home Assistant → Settings → Updates** (native Update entity).
|
||||
- Clicking **Update** runs the same safe pipeline as **Install** (with backup).
|
||||
|
||||
**Tip:** Opening a repository detail view forces an immediate check for the latest version for that repo.
|
||||
|
||||
---
|
||||
|
||||
## Uninstalling
|
||||
|
||||
- Click **Uninstall** on the repository.
|
||||
- BCS removes the integration folders under `custom_components/<domain>`.
|
||||
- The installed state is cleared in the Store.
|
||||
- Restart Home Assistant if prompted.
|
||||
|
||||
---
|
||||
|
||||
## Backups & Restore
|
||||
|
||||
Before an update/install over existing files, BCS creates a backup:
|
||||
|
||||
```
|
||||
/config/.bcs_backups/<domain>/<timestamp>/
|
||||
```
|
||||
|
||||
**Restore**:
|
||||
1. Open the repository in store.
|
||||
2. Select **Restore…**.
|
||||
3. Pick one of the **last backups** (up to retention limit). (Version details are showed in ())
|
||||
4. Confirm – BCS restores files and reconciles installed version to the restored ref.
|
||||
5. Restart Home Assistant if prompted.
|
||||
|
||||
If the old backup lacks metadata, BCS best‑effort derives the installed version from the backup’s `manifest.json`, or marks the ref as `restored:<timestamp>` so updates remain possible.
|
||||
|
||||
---
|
||||
|
||||
## Custom Repositories
|
||||
|
||||
You can add any public repository (GitHub/GitLab/Gitea/Any other Git Hoster). BCS will attempt to detect:
|
||||
- provider & default branch
|
||||
- latest version (release/tag/atom)
|
||||
- repo metadata (prefer `bcs.yaml`, fallback `hacs.json/hacs.yaml`)
|
||||
- readme (common filenames)
|
||||
|
||||
**Add an custom repository**(typical flows):
|
||||
- From the Store UI
|
||||
1. If you start up Bahmcloud Store, you are on tab "Store"
|
||||
2. Go to tab "Manage"
|
||||
3. Add Repository URL (Example: ``https://git.bahmcloud.de/bahmcloud/bahmcloud_store``) and (optional) Name you want to show up (will be grabbed from GIT Repository)
|
||||
4. Repository show up in Custom Repositories-list and in "Store" Tab, if available
|
||||
|
||||
**Remove an custom repository**(typical flows):
|
||||
- From the Store UI
|
||||
1. If you start up Bahmcloud Store, you are on tab "Store"
|
||||
2. Go to tab "Manage"
|
||||
3. Your repository you want to remove (if its custom) show up in the list
|
||||
4. Press "Remove" Button to delete from Store (Attention: If you Remove installed Repository, you won´t be able to Uninstall from Store, you have to remove by your own (Delete Folder from ```config/custom_components/*```))
|
||||
|
||||
Custom repos get the **Custom** badge and can be filtered via **Source**.
|
||||
|
||||
---
|
||||
|
||||
## HACS Repositories
|
||||
|
||||
Enable the **HACS official** toggle to include official HACS integrations.
|
||||
|
||||
- BCS downloads the HACS integration list and maps **human‑readable names/descriptions** from HACS metadata.
|
||||
- HACS entries are **not** part of your BCS-Official Repositories (avoid duplicate entries).
|
||||
|
||||
With many HACS repos, metadata loads in the background; names/descriptions appear progressively and are cached.
|
||||
|
||||
---
|
||||
|
||||
## Update Entities in Home Assistant
|
||||
|
||||
BCS exposes update entities for installed repos:
|
||||
- Found under **Settings → Updates**
|
||||
- Clicking **Install** triggers BCS update pipeline
|
||||
- Shows **installed** and **latest** versions (BCS ref logic)
|
||||
|
||||
---
|
||||
|
||||
## Background Caching & Performance
|
||||
|
||||
- **Fast initial list**: index + local cache only
|
||||
- **Background enrichment**: provider info, latest version, metadata, description, readme (best effort)
|
||||
- **On‑demand**: opening a repo triggers immediate enrichment; data is **persisted** to cache
|
||||
- **Persistent cache**: survives HA restarts; speeds up subsequent runs
|
||||
- **Refresh**: immediately rechecks installed repos and key metadata
|
||||
|
||||
---
|
||||
|
||||
## Restart Required
|
||||
|
||||
After install, update, or restore, BCS raises a **Restart required** item in Home Assistant (Repairs). You can restart directly from there.
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- **New release but no update**: Open the repo detail once; ensure it’s a **release/tag** (commits alone don’t change the ref).
|
||||
- **Descriptions/Latest missing**: Wait for background enrichment or open the repo detail (forces enrichment). Cached afterwards.
|
||||
(You also can Install new version by selecting in Version tab)
|
||||
- **Slow startup**: BCS schedules heavy work after HA started. Keep indexes reasonable.
|
||||
|
||||
---
|
||||
|
||||
## FAQ
|
||||
|
||||
- **Backups path?** `/config/.bcs_backups/<domain>/<timestamp>/`
|
||||
- **Install path?** `/config/custom_components/<domain>`
|
||||
- **Downgrade?** Yes, pick an older version and install.
|
||||
- **Restart needed?** Yes, after install/update/restore.
|
||||
2
bcs.yaml
2
bcs.yaml
@@ -4,7 +4,7 @@ description: >
|
||||
Supports GitHub, GitLab, Gitea and Bahmcloud repositories with
|
||||
a central index, UI panel and API, similar to HACS but independent.
|
||||
|
||||
category: integration
|
||||
category: Integrations
|
||||
|
||||
author: Bahmcloud
|
||||
maintainer: Bahmcloud
|
||||
|
||||
@@ -3,52 +3,84 @@ from __future__ import annotations
|
||||
import logging
|
||||
from datetime import timedelta
|
||||
|
||||
from homeassistant.config_entries import ConfigEntry
|
||||
from homeassistant.core import HomeAssistant
|
||||
from homeassistant.components.panel_custom import async_register_panel
|
||||
from homeassistant.helpers.event import async_track_time_interval
|
||||
from homeassistant.helpers.discovery import async_load_platform
|
||||
from homeassistant.const import EVENT_HOMEASSISTANT_STARTED
|
||||
from homeassistant.helpers.event import async_call_later, async_track_time_interval
|
||||
|
||||
from .core import BCSCore, BCSConfig, BCSError
|
||||
from .const import CONF_GITHUB_TOKEN, DEFAULT_STORE_URL, DOMAIN
|
||||
from .core import BCSError, BCSConfig, BCSCore
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
DOMAIN = "bahmcloud_store"
|
||||
|
||||
DEFAULT_STORE_URL = "https://git.bahmcloud.de/bahmcloud/ha_store/raw/branch/main/store.yaml"
|
||||
CONF_STORE_URL = "store_url"
|
||||
PLATFORMS: list[str] = ["update"]
|
||||
|
||||
|
||||
async def async_setup(hass: HomeAssistant, config: dict) -> bool:
|
||||
cfg = config.get(DOMAIN, {}) or {}
|
||||
store_url = cfg.get(CONF_STORE_URL, DEFAULT_STORE_URL)
|
||||
"""Set up Bahmcloud Store.
|
||||
|
||||
core = BCSCore(hass, BCSConfig(store_url=store_url))
|
||||
hass.data[DOMAIN] = core
|
||||
We intentionally do NOT support YAML configuration.
|
||||
This method is kept so we can log a helpful message if someone tries.
|
||||
"""
|
||||
if DOMAIN in (config or {}):
|
||||
_LOGGER.warning(
|
||||
"BCS YAML configuration is no longer supported. "
|
||||
"Please remove 'bahmcloud_store:' from configuration.yaml and set up the integration via the UI."
|
||||
)
|
||||
return True
|
||||
|
||||
|
||||
async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
||||
"""Set up Bahmcloud Store from a config entry (UI setup)."""
|
||||
# Only one instance.
|
||||
hass.data.setdefault(DOMAIN, {})
|
||||
|
||||
github_token = (entry.options.get(CONF_GITHUB_TOKEN) or "").strip() or None
|
||||
|
||||
core = BCSCore(
|
||||
hass,
|
||||
BCSConfig(
|
||||
store_url=DEFAULT_STORE_URL,
|
||||
github_token=github_token,
|
||||
),
|
||||
)
|
||||
|
||||
hass.data[DOMAIN][entry.entry_id] = core
|
||||
# Keep a convenient shortcut for platforms that previously used hass.data[DOMAIN] directly.
|
||||
hass.data[DOMAIN]["_core"] = core
|
||||
|
||||
await core.async_initialize()
|
||||
|
||||
# Provide native Update entities in Settings -> System -> Updates.
|
||||
# This integration is YAML-based (async_setup), therefore we load the platform manually.
|
||||
await async_load_platform(hass, "update", DOMAIN, {}, config)
|
||||
|
||||
# HTTP views + panel (registered once per entry; we only allow one entry).
|
||||
from .views import (
|
||||
StaticAssetsView,
|
||||
BCSApiView,
|
||||
BCSSettingsView,
|
||||
BCSReadmeView,
|
||||
BCSVersionsView,
|
||||
BCSRepoDetailView,
|
||||
BCSCustomRepoView,
|
||||
BCSInstallView,
|
||||
BCSUpdateView,
|
||||
BCSUninstallView,
|
||||
BCSBackupsView,
|
||||
BCSRestoreView,
|
||||
BCSRestartView,
|
||||
)
|
||||
|
||||
hass.http.register_view(StaticAssetsView())
|
||||
hass.http.register_view(BCSApiView(core))
|
||||
hass.http.register_view(BCSSettingsView(core))
|
||||
hass.http.register_view(BCSReadmeView(core))
|
||||
hass.http.register_view(BCSVersionsView(core))
|
||||
hass.http.register_view(BCSRepoDetailView(core))
|
||||
hass.http.register_view(BCSCustomRepoView(core))
|
||||
hass.http.register_view(BCSInstallView(core))
|
||||
hass.http.register_view(BCSUpdateView(core))
|
||||
hass.http.register_view(BCSUninstallView(core))
|
||||
hass.http.register_view(BCSBackupsView(core))
|
||||
hass.http.register_view(BCSRestoreView(core))
|
||||
hass.http.register_view(BCSRestartView(core))
|
||||
|
||||
await async_register_panel(
|
||||
@@ -56,18 +88,25 @@ async def async_setup(hass: HomeAssistant, config: dict) -> bool:
|
||||
frontend_url_path="bahmcloud-store",
|
||||
webcomponent_name="bahmcloud-store-panel",
|
||||
# IMPORTANT: bump v to avoid caching old JS
|
||||
module_url="/api/bahmcloud_store_static/panel.js?v=102",
|
||||
module_url="/api/bahmcloud_store_static/panel.js?v=109",
|
||||
sidebar_title="Bahmcloud Store",
|
||||
sidebar_icon="mdi:store",
|
||||
require_admin=True,
|
||||
config={},
|
||||
)
|
||||
|
||||
async def _do_startup_refresh(_now=None) -> None:
|
||||
try:
|
||||
await core.full_refresh(source="startup")
|
||||
except BCSError as e:
|
||||
_LOGGER.error("Initial refresh failed: %s", e)
|
||||
|
||||
# Do not block startup; refresh after HA is up.
|
||||
def _on_ha_started(_event) -> None:
|
||||
async_call_later(hass, 30, _do_startup_refresh)
|
||||
|
||||
hass.bus.async_listen_once(EVENT_HOMEASSISTANT_STARTED, _on_ha_started)
|
||||
|
||||
async def periodic(_now) -> None:
|
||||
try:
|
||||
await core.full_refresh(source="timer")
|
||||
@@ -79,4 +118,16 @@ async def async_setup(hass: HomeAssistant, config: dict) -> bool:
|
||||
interval_seconds = int(getattr(core, "refresh_seconds", 300) or 300)
|
||||
async_track_time_interval(hass, periodic, timedelta(seconds=interval_seconds))
|
||||
|
||||
await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
|
||||
return True
|
||||
|
||||
|
||||
async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
||||
"""Unload a config entry."""
|
||||
unload_ok = await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
|
||||
if unload_ok:
|
||||
try:
|
||||
hass.data.get(DOMAIN, {}).pop(entry.entry_id, None)
|
||||
except Exception:
|
||||
pass
|
||||
return unload_ok
|
||||
|
||||
71
custom_components/bahmcloud_store/config_flow.py
Normal file
71
custom_components/bahmcloud_store/config_flow.py
Normal file
@@ -0,0 +1,71 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import logging
|
||||
|
||||
import voluptuous as vol
|
||||
|
||||
from homeassistant import config_entries
|
||||
from homeassistant.core import callback
|
||||
|
||||
from .const import CONF_GITHUB_TOKEN, DOMAIN
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
def _schema(default_token: str | None = None) -> vol.Schema:
|
||||
default_token = (default_token or "").strip()
|
||||
return vol.Schema({vol.Optional(CONF_GITHUB_TOKEN, default=default_token): str})
|
||||
|
||||
|
||||
class BahmcloudStoreConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
|
||||
"""Config flow for Bahmcloud Store.
|
||||
|
||||
The store index URL is fixed and not user-configurable.
|
||||
The only optional setting is a GitHub token to increase API rate limits.
|
||||
"""
|
||||
|
||||
VERSION = 1
|
||||
|
||||
async def async_step_user(self, user_input: dict | None = None):
|
||||
# Allow only one instance.
|
||||
await self.async_set_unique_id(DOMAIN)
|
||||
self._abort_if_unique_id_configured()
|
||||
|
||||
if user_input is None:
|
||||
return self.async_show_form(step_id="user", data_schema=_schema(None))
|
||||
|
||||
token = str(user_input.get(CONF_GITHUB_TOKEN, "")).strip() or None
|
||||
|
||||
return self.async_create_entry(
|
||||
title="Bahmcloud Store",
|
||||
data={},
|
||||
options={CONF_GITHUB_TOKEN: token} if token else {},
|
||||
)
|
||||
|
||||
@staticmethod
|
||||
@callback
|
||||
def async_get_options_flow(config_entry: config_entries.ConfigEntry):
|
||||
return BahmcloudStoreOptionsFlowHandler(config_entry)
|
||||
|
||||
|
||||
class BahmcloudStoreOptionsFlowHandler(config_entries.OptionsFlow):
|
||||
"""Options flow to manage optional GitHub token."""
|
||||
|
||||
def __init__(self, config_entry: config_entries.ConfigEntry) -> None:
|
||||
self._config_entry = config_entry
|
||||
|
||||
async def async_step_init(self, user_input: dict | None = None):
|
||||
if user_input is None:
|
||||
current = self._config_entry.options.get(CONF_GITHUB_TOKEN) or ""
|
||||
return self.async_show_form(step_id="init", data_schema=_schema(str(current)))
|
||||
|
||||
token = str(user_input.get(CONF_GITHUB_TOKEN, "")).strip() or None
|
||||
options = dict(self._config_entry.options)
|
||||
|
||||
# Allow clearing the token.
|
||||
if token:
|
||||
options[CONF_GITHUB_TOKEN] = token
|
||||
else:
|
||||
options.pop(CONF_GITHUB_TOKEN, None)
|
||||
|
||||
return self.async_create_entry(title="", data=options)
|
||||
11
custom_components/bahmcloud_store/const.py
Normal file
11
custom_components/bahmcloud_store/const.py
Normal file
@@ -0,0 +1,11 @@
|
||||
"""Constants for Bahmcloud Store."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
DOMAIN = "bahmcloud_store"
|
||||
|
||||
# Fixed store index URL (not user-configurable).
|
||||
DEFAULT_STORE_URL = "https://git.bahmcloud.de/bahmcloud/ha_store/raw/branch/main/store.yaml"
|
||||
|
||||
# Config entry option keys
|
||||
CONF_GITHUB_TOKEN = "github_token"
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,8 +1,9 @@
|
||||
{
|
||||
"domain": "bahmcloud_store",
|
||||
"name": "Bahmcloud Store",
|
||||
"version": "0.5.10",
|
||||
"version": "0.7.0",
|
||||
"documentation": "https://git.bahmcloud.de/bahmcloud/bahmcloud_store",
|
||||
"config_flow": true,
|
||||
"platforms": ["update"],
|
||||
"requirements": [],
|
||||
"codeowners": ["@bahmcloud"],
|
||||
|
||||
@@ -18,6 +18,12 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
this._filter = "all"; // all|installed|not_installed|updates|custom
|
||||
this._sort = "az"; // az|updates_first|installed_first
|
||||
|
||||
// Source filter (all|bcs|hacs|custom)
|
||||
this._sourceFilter = "all";
|
||||
|
||||
// HACS toggle (settings)
|
||||
this._hacsEnabled = false;
|
||||
|
||||
this._detailRepoId = null;
|
||||
this._detailRepo = null;
|
||||
this._readmeLoading = false;
|
||||
@@ -36,6 +42,24 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
this._uninstallingRepoId = null;
|
||||
this._restartRequired = false;
|
||||
this._lastActionMsg = null;
|
||||
|
||||
// Phase F2.1: restore from backups
|
||||
this._restoreOpen = false;
|
||||
this._restoreRepoId = null;
|
||||
this._restoreLoading = false;
|
||||
this._restoreOptions = [];
|
||||
this._restoreSelected = "";
|
||||
this._restoring = false;
|
||||
this._restoreError = null;
|
||||
|
||||
// Phase C1: selectable install version
|
||||
this._versionsCache = {}; // repo_id -> [{ref,label,source}, ...]
|
||||
this._versionsLoadingRepoId = null;
|
||||
this._selectedVersionByRepoId = {}; // repo_id -> ref ("" means latest)
|
||||
|
||||
// History handling (mobile back button should go back to list, not exit panel)
|
||||
this._historyBound = false;
|
||||
this._handlingPopstate = false;
|
||||
}
|
||||
|
||||
set hass(hass) {
|
||||
@@ -43,10 +67,43 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
if (!this._rendered) {
|
||||
this._rendered = true;
|
||||
this._render();
|
||||
this._ensureHistory();
|
||||
this._load();
|
||||
}
|
||||
}
|
||||
|
||||
_ensureHistory() {
|
||||
if (this._historyBound) return;
|
||||
this._historyBound = true;
|
||||
|
||||
try {
|
||||
// Keep an internal history state for this panel.
|
||||
const current = window.history.state || {};
|
||||
if (!current || current.__bcs !== true) {
|
||||
window.history.replaceState({ __bcs: true, view: "store" }, "");
|
||||
}
|
||||
} catch (e) {
|
||||
// ignore
|
||||
}
|
||||
|
||||
window.addEventListener("popstate", (ev) => {
|
||||
const st = ev?.state;
|
||||
if (!st || st.__bcs !== true) return;
|
||||
|
||||
this._handlingPopstate = true;
|
||||
try {
|
||||
const view = st.view || "store";
|
||||
if (view === "detail" && st.repo_id) {
|
||||
this._openRepoDetail(st.repo_id, false);
|
||||
} else {
|
||||
this._closeDetail(false);
|
||||
}
|
||||
} finally {
|
||||
this._handlingPopstate = false;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
async _load() {
|
||||
if (!this._hass) return;
|
||||
|
||||
@@ -58,6 +115,12 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
const data = await this._hass.callApi("get", "bcs");
|
||||
this._data = data;
|
||||
|
||||
// Persistent settings (e.g. HACS toggle)
|
||||
this._hacsEnabled = !!data?.settings?.hacs_enabled;
|
||||
|
||||
// Sync settings from backend (e.g. HACS toggle)
|
||||
this._hacsEnabled = !!data?.settings?.hacs_enabled;
|
||||
|
||||
if (this._view === "detail" && this._detailRepoId && Array.isArray(data?.repos)) {
|
||||
const fresh = data.repos.find((r) => this._safeId(r?.id) === this._detailRepoId);
|
||||
if (fresh) this._detailRepo = fresh;
|
||||
@@ -70,6 +133,19 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
}
|
||||
}
|
||||
|
||||
async _setSettings(updates) {
|
||||
if (!this._hass) return;
|
||||
try {
|
||||
const resp = await this._hass.callApi("post", "bcs/settings", updates || {});
|
||||
if (resp?.ok) {
|
||||
this._hacsEnabled = !!resp?.settings?.hacs_enabled;
|
||||
}
|
||||
} catch (e) {
|
||||
// Do not fail UI for settings.
|
||||
this._error = e?.message ? String(e.message) : String(e);
|
||||
}
|
||||
}
|
||||
|
||||
async _refreshAll() {
|
||||
if (!this._hass) return;
|
||||
if (this._refreshing) return;
|
||||
@@ -105,7 +181,13 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
this._update();
|
||||
|
||||
try {
|
||||
const resp = await this._hass.callApi("post", `bcs/install?repo_id=${encodeURIComponent(repoId)}`, {});
|
||||
const sel = this._safeText(this._selectedVersionByRepoId?.[repoId] || "").trim();
|
||||
const qv = sel ? `&version=${encodeURIComponent(sel)}` : "";
|
||||
const resp = await this._hass.callApi(
|
||||
"post",
|
||||
`bcs/install?repo_id=${encodeURIComponent(repoId)}${qv}`,
|
||||
{},
|
||||
);
|
||||
if (!resp?.ok) {
|
||||
this._error = this._safeText(resp?.message) || "Install failed.";
|
||||
} else {
|
||||
@@ -131,7 +213,13 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
this._update();
|
||||
|
||||
try {
|
||||
const resp = await this._hass.callApi("post", `bcs/update?repo_id=${encodeURIComponent(repoId)}`, {});
|
||||
const sel = this._safeText(this._selectedVersionByRepoId?.[repoId] || "").trim();
|
||||
const qv = sel ? `&version=${encodeURIComponent(sel)}` : "";
|
||||
const resp = await this._hass.callApi(
|
||||
"post",
|
||||
`bcs/update?repo_id=${encodeURIComponent(repoId)}${qv}`,
|
||||
{},
|
||||
);
|
||||
if (!resp?.ok) {
|
||||
this._error = this._safeText(resp?.message) || "Update failed.";
|
||||
} else {
|
||||
@@ -175,6 +263,90 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
async _openRestore(repoId) {
|
||||
if (!this._hass) return;
|
||||
if (!repoId) return;
|
||||
if (this._installingRepoId || this._updatingRepoId || this._uninstallingRepoId) return;
|
||||
|
||||
this._restoreRepoId = repoId;
|
||||
this._restoreOpen = true;
|
||||
this._restoreLoading = true;
|
||||
this._restoreError = null;
|
||||
this._restoreOptions = [];
|
||||
this._restoreSelected = "";
|
||||
this._update();
|
||||
|
||||
try {
|
||||
const resp = await this._hass.callApi("get", `bcs/backups?repo_id=${encodeURIComponent(repoId)}`);
|
||||
const list = Array.isArray(resp?.backups) ? resp.backups : [];
|
||||
this._restoreOptions = list;
|
||||
const firstComplete = list.find((x) => x && x.complete);
|
||||
const firstAny = list[0];
|
||||
const pick = firstComplete || firstAny;
|
||||
if (pick && pick.id) this._restoreSelected = String(pick.id);
|
||||
|
||||
if (!list.length) {
|
||||
this._restoreError = "No backups found for this repository.";
|
||||
}
|
||||
} catch (e) {
|
||||
this._restoreError = e?.message ? String(e.message) : String(e);
|
||||
} finally {
|
||||
this._restoreLoading = false;
|
||||
this._update();
|
||||
}
|
||||
}
|
||||
|
||||
_closeRestore() {
|
||||
this._restoreOpen = false;
|
||||
this._restoreRepoId = null;
|
||||
this._restoreLoading = false;
|
||||
this._restoreError = null;
|
||||
this._restoreOptions = [];
|
||||
this._restoreSelected = "";
|
||||
this._restoring = false;
|
||||
this._update();
|
||||
}
|
||||
|
||||
async _restoreSelectedBackup() {
|
||||
if (!this._hass) return;
|
||||
if (!this._restoreRepoId) return;
|
||||
const bid = String(this._restoreSelected || "").trim();
|
||||
if (!bid) return;
|
||||
if (this._restoring) return;
|
||||
|
||||
const chosen = (this._restoreOptions || []).find((x) => String(x?.id) === bid);
|
||||
if (chosen && chosen.complete === false) {
|
||||
this._restoreError = "Selected backup is not available for all domains of this repository.";
|
||||
this._update();
|
||||
return;
|
||||
}
|
||||
|
||||
const ok = window.confirm("Restore selected backup? This will overwrite the installed files under /config/custom_components and requires a restart.");
|
||||
if (!ok) return;
|
||||
|
||||
this._restoring = true;
|
||||
this._restoreError = null;
|
||||
this._update();
|
||||
|
||||
try {
|
||||
const resp = await this._hass.callApi("post", `bcs/restore?repo_id=${encodeURIComponent(this._restoreRepoId)}&backup_id=${encodeURIComponent(bid)}`, {});
|
||||
if (!resp?.ok) {
|
||||
this._restoreError = this._safeText(resp?.message) || "Restore failed.";
|
||||
} else {
|
||||
this._restartRequired = !!resp.restart_required;
|
||||
this._lastActionMsg = "Restore finished. Restart required.";
|
||||
this._closeRestore();
|
||||
}
|
||||
} catch (e) {
|
||||
this._restoreError = e?.message ? String(e.message) : String(e);
|
||||
} finally {
|
||||
this._restoring = false;
|
||||
await this._load();
|
||||
}
|
||||
}
|
||||
|
||||
async _restartHA() {
|
||||
if (!this._hass) return;
|
||||
try {
|
||||
@@ -198,23 +370,17 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
}
|
||||
|
||||
_goBack() {
|
||||
if (this._view === "detail") {
|
||||
this._view = "store";
|
||||
this._detailRepoId = null;
|
||||
this._detailRepo = null;
|
||||
this._readmeText = null;
|
||||
this._readmeHtml = null;
|
||||
this._readmeError = null;
|
||||
this._readmeExpanded = false;
|
||||
this._update();
|
||||
return;
|
||||
}
|
||||
try {
|
||||
// Prefer browser history so mobile back behaves as expected.
|
||||
history.back();
|
||||
} catch (_) {
|
||||
if (this._view === "detail") {
|
||||
this._closeDetail(true);
|
||||
} else {
|
||||
window.location.href = "/";
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async _addCustomRepo() {
|
||||
if (!this._hass) return;
|
||||
@@ -258,11 +424,15 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
}
|
||||
}
|
||||
|
||||
_openRepoDetail(repoId) {
|
||||
_openRepoDetail(repoId, pushHistory = true) {
|
||||
const repos = Array.isArray(this._data?.repos) ? this._data.repos : [];
|
||||
const repo = repos.find((r) => this._safeId(r?.id) === repoId);
|
||||
if (!repo) return;
|
||||
|
||||
if (pushHistory) {
|
||||
this._pushHistory({ view: "detail", repo_id: repoId });
|
||||
}
|
||||
|
||||
this._view = "detail";
|
||||
this._detailRepoId = repoId;
|
||||
this._detailRepo = repo;
|
||||
@@ -273,8 +443,60 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
this._readmeExpanded = false;
|
||||
this._readmeCanToggle = false;
|
||||
|
||||
// Versions dropdown
|
||||
if (!(repoId in this._selectedVersionByRepoId)) {
|
||||
this._selectedVersionByRepoId[repoId] = ""; // default = latest
|
||||
}
|
||||
|
||||
this._update();
|
||||
this._loadRepoDetails(repoId);
|
||||
this._loadReadme(repoId);
|
||||
this._loadVersions(repoId);
|
||||
}
|
||||
|
||||
|
||||
async _loadRepoDetails(repoId) {
|
||||
if (!this._hass || !repoId) return;
|
||||
try {
|
||||
const resp = await this._hass.callApi("get", `bcs/repo?repo_id=${encodeURIComponent(repoId)}`);
|
||||
if (resp?.ok && resp.repo) {
|
||||
this._detailRepo = resp.repo;
|
||||
// Also update the cached list item if present
|
||||
const repos = Array.isArray(this._data?.repos) ? this._data.repos : [];
|
||||
const idx = repos.findIndex((r) => this._safeId(r?.id) === repoId);
|
||||
if (idx >= 0) repos[idx] = resp.repo;
|
||||
this._update();
|
||||
}
|
||||
} catch (e) {
|
||||
// ignore: details are optional
|
||||
}
|
||||
}
|
||||
|
||||
async _loadVersions(repoId) {
|
||||
if (!this._hass) return;
|
||||
if (!repoId) return;
|
||||
|
||||
// Cache: avoid re-fetching repeatedly in the same session.
|
||||
if (Array.isArray(this._versionsCache?.[repoId]) && this._versionsCache[repoId].length) {
|
||||
return;
|
||||
}
|
||||
|
||||
this._versionsLoadingRepoId = repoId;
|
||||
this._update();
|
||||
|
||||
try {
|
||||
const resp = await this._hass.callApi("get", `bcs/versions?repo_id=${encodeURIComponent(repoId)}`);
|
||||
if (resp?.ok && Array.isArray(resp.versions)) {
|
||||
this._versionsCache[repoId] = resp.versions;
|
||||
} else {
|
||||
this._versionsCache[repoId] = [];
|
||||
}
|
||||
} catch (e) {
|
||||
this._versionsCache[repoId] = [];
|
||||
} finally {
|
||||
this._versionsLoadingRepoId = null;
|
||||
this._update();
|
||||
}
|
||||
}
|
||||
|
||||
async _loadReadme(repoId) {
|
||||
@@ -399,6 +621,24 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
box-shadow: 0 0 0 2px rgba(30,136,229,.15);
|
||||
}
|
||||
|
||||
.toggle{
|
||||
display:inline-flex;
|
||||
align-items:center;
|
||||
gap:8px;
|
||||
padding:10px 12px;
|
||||
border-radius:14px;
|
||||
border:1px solid var(--divider-color);
|
||||
background: var(--card-background-color);
|
||||
color: var(--primary-text-color);
|
||||
user-select:none;
|
||||
cursor:pointer;
|
||||
}
|
||||
.toggle input{
|
||||
margin:0;
|
||||
width:18px;
|
||||
height:18px;
|
||||
}
|
||||
|
||||
button{
|
||||
padding:10px 12px;
|
||||
border-radius:14px;
|
||||
@@ -413,6 +653,22 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
}
|
||||
button:disabled{ opacity: .55; cursor: not-allowed; }
|
||||
|
||||
.modalOverlay{
|
||||
position:fixed; inset:0; z-index:999;
|
||||
background: rgba(0,0,0,0.45);
|
||||
display:flex; align-items:center; justify-content:center;
|
||||
padding:16px;
|
||||
}
|
||||
.modal{
|
||||
width: min(520px, 100%);
|
||||
background: var(--card-background-color);
|
||||
border:1px solid var(--divider-color);
|
||||
border-radius:18px;
|
||||
padding:16px;
|
||||
box-shadow: 0 10px 30px rgba(0,0,0,0.25);
|
||||
}
|
||||
.modalTitle{ font-size:16px; font-weight:700; }
|
||||
|
||||
.err{
|
||||
margin:12px 0;
|
||||
padding:12px 14px;
|
||||
@@ -617,7 +873,8 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
else if (this._view === "about") html = this._renderAbout();
|
||||
else if (this._view === "detail") html = this._renderDetail();
|
||||
|
||||
content.innerHTML = `${err}${html}`;
|
||||
const modal = this._renderRestoreModal();
|
||||
content.innerHTML = `${err}${html}${modal}`;
|
||||
|
||||
if (this._view === "store") this._wireStore();
|
||||
if (this._view === "manage") this._wireManage();
|
||||
@@ -625,6 +882,8 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
this._wireDetail(); // now always wires buttons
|
||||
}
|
||||
|
||||
this._wireRestoreModal();
|
||||
|
||||
// Restore focus and cursor for the search field after re-render.
|
||||
if (restore.id && this._view === "store") {
|
||||
const el = root.getElementById(restore.id);
|
||||
@@ -678,6 +937,11 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
const cat = this._safeText(r?.category) || "";
|
||||
if (this._category !== "all" && this._category !== cat) return false;
|
||||
|
||||
// Source filter
|
||||
if (this._sourceFilter === "bcs" && r?.source !== "index") return false;
|
||||
if (this._sourceFilter === "hacs" && r?.source !== "hacs") return false;
|
||||
if (this._sourceFilter === "custom" && r?.source !== "custom") return false;
|
||||
|
||||
const latest = this._safeText(r?.latest_version);
|
||||
const installed = this._asBoolStrict(r?.installed);
|
||||
const installedVersion = this._safeText(r?.installed_version);
|
||||
@@ -732,7 +996,11 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
const updateAvailable = installed && !!latest && (!installedVersion || latest !== installedVersion);
|
||||
|
||||
const badges = [];
|
||||
if (r?.source === "custom") badges.push("Custom");
|
||||
// Source badges
|
||||
if (r?.source === "index") badges.push("BCS Official");
|
||||
else if (r?.source === "hacs") badges.push("HACS");
|
||||
else if (r?.source === "custom") badges.push("Custom");
|
||||
|
||||
if (installed) badges.push("Installed");
|
||||
if (updateAvailable) badges.push("Update");
|
||||
|
||||
@@ -758,6 +1026,18 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
return `
|
||||
<div class="filters">
|
||||
<input id="q" placeholder="Search…" value="${this._esc(this._search)}" />
|
||||
|
||||
<label class="toggle" title="Show official HACS repositories">
|
||||
<input id="hacs_toggle" type="checkbox" ${this._hacsEnabled ? "checked" : ""} />
|
||||
<span>HACS</span>
|
||||
</label>
|
||||
|
||||
<select id="src">
|
||||
<option value="all" ${this._sourceFilter === "all" ? "selected" : ""}>All sources</option>
|
||||
<option value="bcs" ${this._sourceFilter === "bcs" ? "selected" : ""}>BCS Official</option>
|
||||
<option value="hacs" ${this._sourceFilter === "hacs" ? "selected" : ""}>HACS</option>
|
||||
<option value="custom" ${this._sourceFilter === "custom" ? "selected" : ""}>Custom</option>
|
||||
</select>
|
||||
<select id="cat">
|
||||
<option value="all">All categories</option>
|
||||
${categories.map((c) => `<option value="${this._esc(c)}" ${this._category === c ? "selected" : ""}>${this._esc(c)}</option>`).join("")}
|
||||
@@ -791,6 +1071,8 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
const cat = root.getElementById("cat");
|
||||
const filter = root.getElementById("filter");
|
||||
const sort = root.getElementById("sort");
|
||||
const src = root.getElementById("src");
|
||||
const hacsToggle = root.getElementById("hacs_toggle");
|
||||
|
||||
if (q) {
|
||||
q.addEventListener("input", (e) => {
|
||||
@@ -817,12 +1099,51 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
});
|
||||
}
|
||||
|
||||
if (src) {
|
||||
src.addEventListener("change", (e) => {
|
||||
this._sourceFilter = e?.target?.value || "all";
|
||||
this._update();
|
||||
});
|
||||
}
|
||||
|
||||
if (hacsToggle) {
|
||||
hacsToggle.addEventListener("change", async (e) => {
|
||||
const enabled = !!e?.target?.checked;
|
||||
this._hacsEnabled = enabled;
|
||||
this._update();
|
||||
await this._setSettings({ hacs_enabled: enabled });
|
||||
await this._load();
|
||||
});
|
||||
}
|
||||
|
||||
root.querySelectorAll("[data-open]").forEach((el) => {
|
||||
const id = el.getAttribute("data-open");
|
||||
el.addEventListener("click", () => this._openRepoDetail(id));
|
||||
el.addEventListener("click", () => this._openRepoDetail(id, true));
|
||||
});
|
||||
}
|
||||
|
||||
_pushHistory(state) {
|
||||
if (this._handlingPopstate) return;
|
||||
try {
|
||||
window.history.pushState({ __bcs: true, ...(state || {}) }, "");
|
||||
} catch (e) {
|
||||
// ignore
|
||||
}
|
||||
}
|
||||
|
||||
_closeDetail(pushHistory = true) {
|
||||
this._view = "store";
|
||||
this._detailRepoId = null;
|
||||
this._detailRepo = null;
|
||||
this._readmeText = null;
|
||||
this._readmeHtml = null;
|
||||
this._readmeError = null;
|
||||
this._readmeExpanded = false;
|
||||
this._readmeCanToggle = false;
|
||||
if (pushHistory) this._pushHistory({ view: "store" });
|
||||
this._update();
|
||||
}
|
||||
|
||||
_renderAbout() {
|
||||
return `
|
||||
<div class="card">
|
||||
@@ -841,6 +1162,8 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
const r = this._detailRepo;
|
||||
if (!r) return `<div class="card">No repository selected.</div>`;
|
||||
|
||||
const repoId = this._safeId(r?.id) || this._detailRepoId || "";
|
||||
|
||||
const name = this._safeText(r?.name) || "Unnamed repository";
|
||||
const url = this._safeText(r?.url) || "";
|
||||
const desc = this._safeText(r?.description) || "";
|
||||
@@ -889,8 +1212,6 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
</div>
|
||||
`;
|
||||
|
||||
const repoId = this._safeId(r?.id);
|
||||
|
||||
const installed = this._asBoolStrict(r?.installed);
|
||||
const installedVersion = this._safeText(r?.installed_version);
|
||||
const installedDomains = Array.isArray(r?.installed_domains) ? r.installed_domains : [];
|
||||
@@ -903,9 +1224,36 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
|
||||
const updateAvailable = installed && !!latestVersion && (!installedVersion || latestVersion !== installedVersion);
|
||||
|
||||
const versions = Array.isArray(this._versionsCache?.[repoId]) ? this._versionsCache[repoId] : [];
|
||||
const versionsLoading = this._versionsLoadingRepoId === repoId;
|
||||
const selectedRef = this._safeText(this._selectedVersionByRepoId?.[repoId] || "").trim();
|
||||
|
||||
let versionOptions = `<option value="">Latest (recommended)</option>`;
|
||||
if (selectedRef && !versions.some((v) => this._safeText(v?.ref) === selectedRef)) {
|
||||
versionOptions += `<option value="${this._esc(selectedRef)}" selected>Selected: ${this._esc(selectedRef)}</option>`;
|
||||
}
|
||||
for (const v of versions) {
|
||||
const ref = this._safeText(v?.ref);
|
||||
if (!ref) continue;
|
||||
const label = this._safeText(v?.label) || ref;
|
||||
const sel = selectedRef === ref ? "selected" : "";
|
||||
versionOptions += `<option value="${this._esc(ref)}" ${sel}>${this._esc(label)}</option>`;
|
||||
}
|
||||
|
||||
const versionSelect = `
|
||||
<div style="margin-top:12px;">
|
||||
<div class="muted small" style="margin-bottom:6px;"><strong>Install version:</strong></div>
|
||||
<select id="selVersion" ${busy ? "disabled" : ""} style="width:100%;">
|
||||
${versionOptions}
|
||||
</select>
|
||||
${versionsLoading ? `<div class="muted small" style="margin-top:6px;">Loading versions…</div>` : ``}
|
||||
</div>
|
||||
`;
|
||||
|
||||
const installBtn = `<button class="primary" id="btnInstall" ${installed || busy ? "disabled" : ""}>${busyInstall ? "Installing…" : installed ? "Installed" : "Install"}</button>`;
|
||||
const updateBtn = `<button class="primary" id="btnUpdate" ${!updateAvailable || busy ? "disabled" : ""}>${busyUpdate ? "Updating…" : updateAvailable ? "Update" : "Up to date"}</button>`;
|
||||
const uninstallBtn = `<button class="primary" id="btnUninstall" ${!installed || busy ? "disabled" : ""}>${busyUninstall ? "Uninstalling…" : "Uninstall"}</button>`;
|
||||
const restoreBtn = `<button class="primary" id="btnRestore" ${!installed || busy ? "disabled" : ""}>Restore</button>`;
|
||||
|
||||
const restartHint = this._restartRequired
|
||||
? `
|
||||
@@ -954,10 +1302,13 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
<div style="margin-top:6px;"><strong>Domains:</strong> ${installedDomains.length ? this._esc(installedDomains.join(", ")) : "-"}</div>
|
||||
</div>
|
||||
|
||||
${versionSelect}
|
||||
|
||||
<div class="row" style="margin-top:14px; gap:10px; flex-wrap:wrap;">
|
||||
${installBtn}
|
||||
${updateBtn}
|
||||
${uninstallBtn}
|
||||
${restoreBtn}
|
||||
</div>
|
||||
|
||||
${restartHint}
|
||||
@@ -974,8 +1325,10 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
const btnInstall = root.getElementById("btnInstall");
|
||||
const btnUpdate = root.getElementById("btnUpdate");
|
||||
const btnUninstall = root.getElementById("btnUninstall");
|
||||
const btnRestore = root.getElementById("btnRestore");
|
||||
const btnRestart = root.getElementById("btnRestart");
|
||||
const btnReadmeToggle = root.getElementById("btnReadmeToggle");
|
||||
const selVersion = root.getElementById("selVersion");
|
||||
|
||||
if (btnInstall) {
|
||||
btnInstall.addEventListener("click", () => {
|
||||
@@ -984,6 +1337,14 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
});
|
||||
}
|
||||
|
||||
if (selVersion) {
|
||||
selVersion.addEventListener("change", () => {
|
||||
if (!this._detailRepoId) return;
|
||||
const v = selVersion.value != null ? String(selVersion.value) : "";
|
||||
this._selectedVersionByRepoId[this._detailRepoId] = v;
|
||||
});
|
||||
}
|
||||
|
||||
if (btnUpdate) {
|
||||
btnUpdate.addEventListener("click", () => {
|
||||
if (btnUpdate.disabled) return;
|
||||
@@ -998,6 +1359,15 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
});
|
||||
}
|
||||
|
||||
if (btnRestore) {
|
||||
btnRestore.addEventListener("click", () => {
|
||||
if (btnRestore.disabled) return;
|
||||
if (this._detailRepoId) this._openRestore(this._detailRepoId);
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
|
||||
if (btnRestart) {
|
||||
btnRestart.addEventListener("click", () => this._restartHA());
|
||||
}
|
||||
@@ -1024,6 +1394,45 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
}
|
||||
}
|
||||
|
||||
_wireRestoreModal() {
|
||||
const root = this.shadowRoot;
|
||||
if (!root) return;
|
||||
|
||||
const overlay = root.getElementById("restoreOverlay");
|
||||
if (!overlay) return;
|
||||
|
||||
// Click outside modal closes it
|
||||
overlay.addEventListener("click", (ev) => {
|
||||
if (ev.target === overlay) this._closeRestore();
|
||||
});
|
||||
|
||||
const sel = root.getElementById("restoreSelect");
|
||||
if (sel) {
|
||||
try {
|
||||
if (this._restoreSelected) sel.value = String(this._restoreSelected);
|
||||
} catch (_) {}
|
||||
sel.addEventListener("change", () => {
|
||||
this._restoreSelected = String(sel.value || "");
|
||||
});
|
||||
}
|
||||
|
||||
const btnCancel = root.getElementById("btnRestoreCancel");
|
||||
if (btnCancel) {
|
||||
btnCancel.addEventListener("click", () => this._closeRestore());
|
||||
}
|
||||
|
||||
const btnApply = root.getElementById("btnRestoreApply");
|
||||
if (btnApply) {
|
||||
btnApply.addEventListener("click", () => {
|
||||
if (btnApply.disabled) return;
|
||||
const v = root.getElementById("restoreSelect")?.value;
|
||||
if (v) this._restoreSelected = String(v);
|
||||
this._restoreSelectedBackup();
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
_postprocessRenderedMarkdown(container) {
|
||||
if (!container) return;
|
||||
try {
|
||||
@@ -1036,6 +1445,52 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
}
|
||||
|
||||
|
||||
_renderRestoreModal() {
|
||||
if (!this._restoreOpen) return "";
|
||||
|
||||
const opts = Array.isArray(this._restoreOptions) ? this._restoreOptions : [];
|
||||
const disabled = this._restoreLoading || this._restoring || !opts.length;
|
||||
|
||||
const optionsHtml = opts
|
||||
.map((o) => {
|
||||
const id = this._safeText(o?.id) || "";
|
||||
const label = this._safeText(o?.label) || id;
|
||||
return `<option value="${this._esc(id)}">${this._esc(label)}</option>`;
|
||||
})
|
||||
.join("");
|
||||
|
||||
const msg = this._restoreLoading
|
||||
? "Loading backups…"
|
||||
: this._restoreError
|
||||
? this._safeText(this._restoreError)
|
||||
: opts.length
|
||||
? "Select a backup to restore. This will overwrite files under /config/custom_components and requires a restart."
|
||||
: "No backups found.";
|
||||
|
||||
return `
|
||||
<div class="modalOverlay" id="restoreOverlay">
|
||||
<div class="modal">
|
||||
<div class="modalTitle">Restore from backup</div>
|
||||
<div class="muted" style="margin-top:8px;">${this._esc(msg)}</div>
|
||||
|
||||
<div style="margin-top:14px;">
|
||||
<label class="muted small" for="restoreSelect">Backup</label><br/>
|
||||
<select id="restoreSelect" ${disabled ? "disabled" : ""} style="width:100%; margin-top:6px;">
|
||||
${optionsHtml}
|
||||
</select>
|
||||
</div>
|
||||
|
||||
<div class="row" style="margin-top:16px; justify-content:flex-end; gap:10px;">
|
||||
<button id="btnRestoreCancel">Cancel</button>
|
||||
<button class="primary" id="btnRestoreApply" ${disabled ? "disabled" : ""}>${this._restoring ? "Restoring…" : "Restore"}</button>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
`;
|
||||
}
|
||||
|
||||
|
||||
|
||||
_renderManage() {
|
||||
const repos = Array.isArray(this._data.repos) ? this._data.repos : [];
|
||||
const custom = repos.filter((r) => r?.source === "custom");
|
||||
|
||||
@@ -189,9 +189,11 @@ async def _github_latest_version_redirect(hass: HomeAssistant, owner: str, repo:
|
||||
return None, None
|
||||
|
||||
|
||||
async def _github_latest_version_api(hass: HomeAssistant, owner: str, repo: str) -> tuple[str | None, str | None]:
|
||||
async def _github_latest_version_api(
|
||||
hass: HomeAssistant, owner: str, repo: str, *, github_token: str | None = None
|
||||
) -> tuple[str | None, str | None]:
|
||||
session = async_get_clientsession(hass)
|
||||
headers = {"Accept": "application/vnd.github+json", "User-Agent": UA}
|
||||
headers = _github_headers(github_token)
|
||||
|
||||
data, status = await _safe_json(session, f"https://api.github.com/repos/{owner}/{repo}/releases/latest", headers=headers)
|
||||
if isinstance(data, dict) and data.get("tag_name"):
|
||||
@@ -217,12 +219,14 @@ async def _github_latest_version_api(hass: HomeAssistant, owner: str, repo: str)
|
||||
return None, None
|
||||
|
||||
|
||||
async def _github_latest_version(hass: HomeAssistant, owner: str, repo: str) -> tuple[str | None, str | None]:
|
||||
async def _github_latest_version(
|
||||
hass: HomeAssistant, owner: str, repo: str, *, github_token: str | None = None
|
||||
) -> tuple[str | None, str | None]:
|
||||
tag, src = await _github_latest_version_redirect(hass, owner, repo)
|
||||
if tag:
|
||||
return tag, src
|
||||
|
||||
tag, src = await _github_latest_version_api(hass, owner, repo)
|
||||
tag, src = await _github_latest_version_api(hass, owner, repo, github_token=github_token)
|
||||
if tag:
|
||||
return tag, src
|
||||
|
||||
@@ -316,7 +320,16 @@ async def _gitlab_latest_version(
|
||||
return None, None
|
||||
|
||||
|
||||
async def fetch_repo_info(hass: HomeAssistant, repo_url: str) -> RepoInfo:
|
||||
def _github_headers(github_token: str | None = None) -> dict:
|
||||
headers = {"Accept": "application/vnd.github+json", "User-Agent": UA}
|
||||
token = (github_token or "").strip()
|
||||
if token:
|
||||
# PAT or fine-grained token
|
||||
headers["Authorization"] = f"Bearer {token}"
|
||||
return headers
|
||||
|
||||
|
||||
async def fetch_repo_info(hass: HomeAssistant, repo_url: str, *, github_token: str | None = None) -> RepoInfo:
|
||||
provider = detect_provider(repo_url)
|
||||
owner, repo = _split_owner_repo(repo_url)
|
||||
|
||||
@@ -337,7 +350,7 @@ async def fetch_repo_info(hass: HomeAssistant, repo_url: str) -> RepoInfo:
|
||||
|
||||
try:
|
||||
if provider == "github":
|
||||
headers = {"Accept": "application/vnd.github+json", "User-Agent": UA}
|
||||
headers = _github_headers(github_token)
|
||||
data, status = await _safe_json(session, f"https://api.github.com/repos/{owner}/{repo}", headers=headers)
|
||||
|
||||
if isinstance(data, dict):
|
||||
@@ -356,7 +369,7 @@ async def fetch_repo_info(hass: HomeAssistant, repo_url: str) -> RepoInfo:
|
||||
if desc:
|
||||
info.description = desc
|
||||
|
||||
ver, src = await _github_latest_version(hass, owner, repo)
|
||||
ver, src = await _github_latest_version(hass, owner, repo, github_token=github_token)
|
||||
info.latest_version = ver
|
||||
info.latest_version_source = src
|
||||
return info
|
||||
@@ -505,3 +518,162 @@ async def fetch_readme_markdown(
|
||||
continue
|
||||
|
||||
return None
|
||||
|
||||
|
||||
async def fetch_repo_versions(
|
||||
hass: HomeAssistant,
|
||||
repo_url: str,
|
||||
*,
|
||||
provider: str | None = None,
|
||||
default_branch: str | None = None,
|
||||
limit: int = 20,
|
||||
github_token: str | None = None,
|
||||
) -> list[dict[str, str]]:
|
||||
"""List available versions/refs for a repository.
|
||||
|
||||
Returns a list of dicts with keys:
|
||||
- ref: the ref to install (tag/release/branch)
|
||||
- label: human-friendly label
|
||||
- source: release|tag|branch
|
||||
|
||||
Notes:
|
||||
- Uses public endpoints (no tokens) for public repositories.
|
||||
- We prefer releases first (if available), then tags.
|
||||
"""
|
||||
|
||||
repo_url = (repo_url or "").strip()
|
||||
if not repo_url:
|
||||
return []
|
||||
|
||||
prov = (provider or "").strip().lower() if provider else ""
|
||||
if not prov:
|
||||
prov = detect_provider(repo_url)
|
||||
|
||||
owner, repo = _split_owner_repo(repo_url)
|
||||
if not owner or not repo:
|
||||
return []
|
||||
|
||||
session = async_get_clientsession(hass)
|
||||
headers = {"User-Agent": UA}
|
||||
if prov == "github":
|
||||
headers = _github_headers(github_token)
|
||||
|
||||
out: list[dict[str, str]] = []
|
||||
seen: set[str] = set()
|
||||
|
||||
def _add(ref: str | None, label: str, source: str) -> None:
|
||||
r = (ref or "").strip()
|
||||
if not r or r in seen:
|
||||
return
|
||||
seen.add(r)
|
||||
out.append({"ref": r, "label": label, "source": source})
|
||||
|
||||
# Always offer default branch as an explicit option.
|
||||
if default_branch and str(default_branch).strip():
|
||||
b = str(default_branch).strip()
|
||||
_add(b, f"Branch: {b}", "branch")
|
||||
|
||||
try:
|
||||
if prov == "github":
|
||||
# Releases
|
||||
gh_headers = {"Accept": "application/vnd.github+json", "User-Agent": UA}
|
||||
data, _ = await _safe_json(
|
||||
session,
|
||||
f"https://api.github.com/repos/{owner}/{repo}/releases?per_page={int(limit)}",
|
||||
headers=gh_headers,
|
||||
)
|
||||
if isinstance(data, list):
|
||||
for r in data:
|
||||
if not isinstance(r, dict):
|
||||
continue
|
||||
tag = r.get("tag_name")
|
||||
name = r.get("name")
|
||||
if tag:
|
||||
lbl = str(tag)
|
||||
if isinstance(name, str) and name.strip() and name.strip() != str(tag):
|
||||
lbl = f"{tag} — {name.strip()}"
|
||||
_add(str(tag), lbl, "release")
|
||||
|
||||
# Tags
|
||||
data, _ = await _safe_json(
|
||||
session,
|
||||
f"https://api.github.com/repos/{owner}/{repo}/tags?per_page={int(limit)}",
|
||||
headers=gh_headers,
|
||||
)
|
||||
if isinstance(data, list):
|
||||
for t in data:
|
||||
if isinstance(t, dict) and t.get("name"):
|
||||
_add(str(t["name"]), str(t["name"]), "tag")
|
||||
|
||||
return out
|
||||
|
||||
if prov == "gitlab":
|
||||
u = urlparse(repo_url.rstrip("/"))
|
||||
base = f"{u.scheme}://{u.netloc}"
|
||||
project = quote_plus(f"{owner}/{repo}")
|
||||
|
||||
data, _ = await _safe_json(
|
||||
session,
|
||||
f"{base}/api/v4/projects/{project}/releases?per_page={int(limit)}",
|
||||
headers=headers,
|
||||
)
|
||||
if isinstance(data, list):
|
||||
for r in data:
|
||||
if not isinstance(r, dict):
|
||||
continue
|
||||
tag = r.get("tag_name")
|
||||
name = r.get("name")
|
||||
if tag:
|
||||
lbl = str(tag)
|
||||
if isinstance(name, str) and name.strip() and name.strip() != str(tag):
|
||||
lbl = f"{tag} — {name.strip()}"
|
||||
_add(str(tag), lbl, "release")
|
||||
|
||||
data, _ = await _safe_json(
|
||||
session,
|
||||
f"{base}/api/v4/projects/{project}/repository/tags?per_page={int(limit)}",
|
||||
headers=headers,
|
||||
)
|
||||
if isinstance(data, list):
|
||||
for t in data:
|
||||
if isinstance(t, dict) and t.get("name"):
|
||||
_add(str(t["name"]), str(t["name"]), "tag")
|
||||
|
||||
return out
|
||||
|
||||
# gitea (incl. Bahmcloud)
|
||||
u = urlparse(repo_url.rstrip("/"))
|
||||
base = f"{u.scheme}://{u.netloc}"
|
||||
|
||||
data, _ = await _safe_json(
|
||||
session,
|
||||
f"{base}/api/v1/repos/{owner}/{repo}/releases?limit={int(limit)}",
|
||||
headers=headers,
|
||||
)
|
||||
if isinstance(data, list):
|
||||
for r in data:
|
||||
if not isinstance(r, dict):
|
||||
continue
|
||||
tag = r.get("tag_name")
|
||||
name = r.get("name")
|
||||
if tag:
|
||||
lbl = str(tag)
|
||||
if isinstance(name, str) and name.strip() and name.strip() != str(tag):
|
||||
lbl = f"{tag} — {name.strip()}"
|
||||
_add(str(tag), lbl, "release")
|
||||
|
||||
data, _ = await _safe_json(
|
||||
session,
|
||||
f"{base}/api/v1/repos/{owner}/{repo}/tags?limit={int(limit)}",
|
||||
headers=headers,
|
||||
)
|
||||
if isinstance(data, list):
|
||||
for t in data:
|
||||
if isinstance(t, dict) and t.get("name"):
|
||||
_add(str(t["name"]), str(t["name"]), "tag")
|
||||
|
||||
return out
|
||||
|
||||
except Exception:
|
||||
_LOGGER.debug("fetch_repo_versions failed for %s", repo_url, exc_info=True)
|
||||
return out
|
||||
@@ -36,6 +36,9 @@ class BCSStorage:
|
||||
Keys:
|
||||
- custom_repos: list of manually added repositories
|
||||
- installed_repos: mapping repo_id -> installed metadata
|
||||
- settings: persistent user settings (e.g. toggles in the UI)
|
||||
- hacs_cache: cached HACS metadata to improve UX (display names/descriptions)
|
||||
- repo_cache: cached per-repo enrichment (names/descriptions/versions) to keep the UI populated after restart
|
||||
"""
|
||||
|
||||
def __init__(self, hass: HomeAssistant) -> None:
|
||||
@@ -53,8 +56,92 @@ class BCSStorage:
|
||||
if "installed_repos" not in data or not isinstance(data.get("installed_repos"), dict):
|
||||
data["installed_repos"] = {}
|
||||
|
||||
if "settings" not in data or not isinstance(data.get("settings"), dict):
|
||||
data["settings"] = {}
|
||||
|
||||
if "hacs_cache" not in data or not isinstance(data.get("hacs_cache"), dict):
|
||||
data["hacs_cache"] = {}
|
||||
|
||||
if "repo_cache" not in data or not isinstance(data.get("repo_cache"), dict):
|
||||
data["repo_cache"] = {}
|
||||
|
||||
return data
|
||||
|
||||
async def get_repo_cache(self) -> dict[str, Any]:
|
||||
"""Return cached per-repo enrichment data.
|
||||
|
||||
Shape:
|
||||
{
|
||||
"fetched_at": <unix_ts>,
|
||||
"repos": {
|
||||
"<repo_id>": {
|
||||
"ts": <unix_ts>,
|
||||
"url": "...",
|
||||
"name": "...",
|
||||
"provider_description": "...",
|
||||
"meta_name": "...",
|
||||
"meta_description": "...",
|
||||
"meta_category": "...",
|
||||
"meta_source": "...",
|
||||
"latest_version": "...",
|
||||
"latest_version_source": "...",
|
||||
"default_branch": "...",
|
||||
"owner": "...",
|
||||
"provider_repo_name": "..."
|
||||
}
|
||||
}
|
||||
}
|
||||
"""
|
||||
data = await self._load()
|
||||
cache = data.get("repo_cache", {})
|
||||
return cache if isinstance(cache, dict) else {}
|
||||
|
||||
async def set_repo_cache(self, cache: dict[str, Any]) -> None:
|
||||
"""Persist cached per-repo enrichment data."""
|
||||
data = await self._load()
|
||||
data["repo_cache"] = cache if isinstance(cache, dict) else {}
|
||||
await self._save(data)
|
||||
|
||||
async def get_hacs_cache(self) -> dict[str, Any]:
|
||||
"""Return cached HACS metadata.
|
||||
|
||||
Shape:
|
||||
{
|
||||
"fetched_at": <unix_ts>,
|
||||
"repos": {"owner/repo": {"name": "...", "description": "...", "domain": "..."}}
|
||||
}
|
||||
"""
|
||||
data = await self._load()
|
||||
cache = data.get("hacs_cache", {})
|
||||
return cache if isinstance(cache, dict) else {}
|
||||
|
||||
async def set_hacs_cache(self, cache: dict[str, Any]) -> None:
|
||||
"""Persist cached HACS metadata."""
|
||||
data = await self._load()
|
||||
data["hacs_cache"] = cache if isinstance(cache, dict) else {}
|
||||
await self._save(data)
|
||||
|
||||
async def get_settings(self) -> dict[str, Any]:
|
||||
"""Return persistent settings.
|
||||
|
||||
Currently used for UI/behavior toggles.
|
||||
"""
|
||||
data = await self._load()
|
||||
settings = data.get("settings", {})
|
||||
return settings if isinstance(settings, dict) else {}
|
||||
|
||||
async def set_settings(self, updates: dict[str, Any]) -> dict[str, Any]:
|
||||
"""Update persistent settings and return the merged settings."""
|
||||
data = await self._load()
|
||||
settings = data.get("settings", {})
|
||||
if not isinstance(settings, dict):
|
||||
settings = {}
|
||||
for k, v in (updates or {}).items():
|
||||
settings[str(k)] = v
|
||||
data["settings"] = settings
|
||||
await self._save(data)
|
||||
return settings
|
||||
|
||||
async def _save(self, data: dict[str, Any]) -> None:
|
||||
await self._store.async_save(data)
|
||||
|
||||
|
||||
@@ -1,4 +1,29 @@
|
||||
{
|
||||
"config": {
|
||||
"abort": {
|
||||
"single_instance_allowed": "Only one Bahmcloud Store instance can be configured."
|
||||
},
|
||||
"step": {
|
||||
"user": {
|
||||
"title": "Bahmcloud Store",
|
||||
"description": "Bahmcloud Store uses a fixed official store index. You can optionally add a GitHub token to increase API rate limits.",
|
||||
"data": {
|
||||
"github_token": "GitHub token (optional)"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"options": {
|
||||
"step": {
|
||||
"init": {
|
||||
"title": "Bahmcloud Store Options",
|
||||
"description": "Optionally set or clear your GitHub token to reduce rate limiting.",
|
||||
"data": {
|
||||
"github_token": "GitHub token (optional)"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"issues": {
|
||||
"restart_required": {
|
||||
"title": "Restart required",
|
||||
|
||||
@@ -10,11 +10,21 @@ from homeassistant.helpers.dispatcher import async_dispatcher_connect
|
||||
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
||||
from homeassistant.helpers.entity import EntityCategory
|
||||
|
||||
from .core import DOMAIN, SIGNAL_UPDATED, BCSCore
|
||||
from .const import DOMAIN
|
||||
from .core import SIGNAL_UPDATED, BCSCore
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
def _get_core(hass: HomeAssistant) -> BCSCore | None:
|
||||
data = hass.data.get(DOMAIN)
|
||||
if isinstance(data, dict):
|
||||
c = data.get("_core")
|
||||
return c if isinstance(c, BCSCore) else None
|
||||
# Backwards compatibility (older versions used hass.data[DOMAIN] = core)
|
||||
return data if isinstance(data, BCSCore) else None
|
||||
|
||||
|
||||
def _pretty_repo_name(core: BCSCore, repo_id: str) -> str:
|
||||
"""Return a human-friendly name for a repo update entity."""
|
||||
try:
|
||||
@@ -146,7 +156,7 @@ async def async_setup_platform(
|
||||
discovery_info=None,
|
||||
):
|
||||
"""Set up BCS update entities."""
|
||||
core: BCSCore | None = hass.data.get(DOMAIN)
|
||||
core: BCSCore | None = _get_core(hass)
|
||||
if not core:
|
||||
_LOGGER.debug("BCS core not available, skipping update platform setup")
|
||||
return
|
||||
@@ -160,3 +170,12 @@ async def async_setup_platform(
|
||||
_sync_entities(core, entities, async_add_entities)
|
||||
|
||||
async_dispatcher_connect(hass, SIGNAL_UPDATED, _handle_update)
|
||||
|
||||
|
||||
async def async_setup_entry(
|
||||
hass: HomeAssistant,
|
||||
entry,
|
||||
async_add_entities: AddEntitiesCallback,
|
||||
) -> None:
|
||||
"""Set up BCS update entities from a config entry."""
|
||||
await async_setup_platform(hass, {}, async_add_entities, None)
|
||||
@@ -215,7 +215,12 @@ class BCSApiView(HomeAssistantView):
|
||||
|
||||
async def get(self, request: web.Request) -> web.Response:
|
||||
return web.json_response(
|
||||
{"ok": True, "version": self.core.version, "repos": self.core.list_repos_public()}
|
||||
{
|
||||
"ok": True,
|
||||
"version": self.core.version,
|
||||
"settings": self.core.get_settings_public(),
|
||||
"repos": self.core.list_repos_public(),
|
||||
}
|
||||
)
|
||||
|
||||
async def post(self, request: web.Request) -> web.Response:
|
||||
@@ -248,6 +253,37 @@ class BCSApiView(HomeAssistantView):
|
||||
return web.json_response({"ok": False, "message": "Unknown operation"}, status=400)
|
||||
|
||||
|
||||
class BCSSettingsView(HomeAssistantView):
|
||||
"""Persistent UI settings (e.g. toggles)."""
|
||||
|
||||
url = "/api/bcs/settings"
|
||||
name = "api:bcs_settings"
|
||||
requires_auth = True
|
||||
|
||||
def __init__(self, core: Any) -> None:
|
||||
self.core: BCSCore = core
|
||||
|
||||
async def get(self, request: web.Request) -> web.Response:
|
||||
return web.json_response({"ok": True, "settings": self.core.get_settings_public()})
|
||||
|
||||
async def post(self, request: web.Request) -> web.Response:
|
||||
try:
|
||||
data = await request.json()
|
||||
except Exception:
|
||||
data = {}
|
||||
|
||||
updates: dict[str, Any] = {}
|
||||
if "hacs_enabled" in data:
|
||||
updates["hacs_enabled"] = bool(data.get("hacs_enabled"))
|
||||
|
||||
try:
|
||||
settings = await self.core.set_settings(updates)
|
||||
return web.json_response({"ok": True, "settings": settings})
|
||||
except Exception as e:
|
||||
_LOGGER.exception("BCS set settings failed: %s", e)
|
||||
return web.json_response({"ok": False, "message": str(e) or "Failed"}, status=500)
|
||||
|
||||
|
||||
class BCSCustomRepoView(HomeAssistantView):
|
||||
url = "/api/bcs/custom_repo"
|
||||
name = "api:bcs_custom_repo"
|
||||
@@ -292,6 +328,27 @@ class BCSReadmeView(HomeAssistantView):
|
||||
return web.json_response({"ok": True, "readme": md_str, "html": html})
|
||||
|
||||
|
||||
class BCSVersionsView(HomeAssistantView):
|
||||
url = "/api/bcs/versions"
|
||||
name = "api:bcs_versions"
|
||||
requires_auth = True
|
||||
|
||||
def __init__(self, core: Any) -> None:
|
||||
self.core: BCSCore = core
|
||||
|
||||
async def get(self, request: web.Request) -> web.Response:
|
||||
repo_id = request.query.get("repo_id")
|
||||
if not repo_id:
|
||||
return web.json_response({"ok": False, "message": "Missing repo_id"}, status=400)
|
||||
|
||||
try:
|
||||
versions = await self.core.list_repo_versions(repo_id)
|
||||
return web.json_response({"ok": True, "repo_id": repo_id, "versions": versions}, status=200)
|
||||
except Exception as e:
|
||||
_LOGGER.exception("BCS list versions failed: %s", e)
|
||||
return web.json_response({"ok": False, "message": str(e) or "List versions failed"}, status=500)
|
||||
|
||||
|
||||
class BCSInstallView(HomeAssistantView):
|
||||
url = "/api/bcs/install"
|
||||
name = "api:bcs_install"
|
||||
@@ -302,11 +359,13 @@ class BCSInstallView(HomeAssistantView):
|
||||
|
||||
async def post(self, request: web.Request) -> web.Response:
|
||||
repo_id = request.query.get("repo_id")
|
||||
version = request.query.get("version")
|
||||
if not repo_id:
|
||||
return web.json_response({"ok": False, "message": "Missing repo_id"}, status=400)
|
||||
|
||||
try:
|
||||
result = await self.core.install_repo(repo_id)
|
||||
v = str(version).strip() if version is not None else None
|
||||
result = await self.core.install_repo(repo_id, version=v)
|
||||
return web.json_response(result, status=200)
|
||||
except Exception as e:
|
||||
_LOGGER.exception("BCS install failed: %s", e)
|
||||
@@ -323,11 +382,13 @@ class BCSUpdateView(HomeAssistantView):
|
||||
|
||||
async def post(self, request: web.Request) -> web.Response:
|
||||
repo_id = request.query.get("repo_id")
|
||||
version = request.query.get("version")
|
||||
if not repo_id:
|
||||
return web.json_response({"ok": False, "message": "Missing repo_id"}, status=400)
|
||||
|
||||
try:
|
||||
result = await self.core.update_repo(repo_id)
|
||||
v = str(version).strip() if version is not None else None
|
||||
result = await self.core.update_repo(repo_id, version=v)
|
||||
return web.json_response(result, status=200)
|
||||
except Exception as e:
|
||||
_LOGGER.exception("BCS update failed: %s", e)
|
||||
@@ -355,6 +416,53 @@ class BCSUninstallView(HomeAssistantView):
|
||||
return web.json_response({"ok": False, "message": str(e) or "Uninstall failed"}, status=500)
|
||||
|
||||
|
||||
|
||||
|
||||
class BCSBackupsView(HomeAssistantView):
|
||||
url = "/api/bcs/backups"
|
||||
name = "api:bcs_backups"
|
||||
requires_auth = True
|
||||
|
||||
def __init__(self, core: Any) -> None:
|
||||
self.core: BCSCore = core
|
||||
|
||||
async def get(self, request: web.Request) -> web.Response:
|
||||
repo_id = request.query.get("repo_id")
|
||||
if not repo_id:
|
||||
return web.json_response({"ok": False, "message": "Missing repo_id"}, status=400)
|
||||
|
||||
try:
|
||||
backups = await self.core.list_repo_backups(repo_id)
|
||||
return web.json_response({"ok": True, "repo_id": repo_id, "backups": backups}, status=200)
|
||||
except Exception as e:
|
||||
_LOGGER.exception("BCS list backups failed: %s", e)
|
||||
return web.json_response({"ok": False, "message": str(e) or "List backups failed"}, status=500)
|
||||
|
||||
|
||||
class BCSRestoreView(HomeAssistantView):
|
||||
url = "/api/bcs/restore"
|
||||
name = "api:bcs_restore"
|
||||
requires_auth = True
|
||||
|
||||
def __init__(self, core: Any) -> None:
|
||||
self.core: BCSCore = core
|
||||
|
||||
async def post(self, request: web.Request) -> web.Response:
|
||||
repo_id = request.query.get("repo_id")
|
||||
backup_id = request.query.get("backup_id")
|
||||
if not repo_id:
|
||||
return web.json_response({"ok": False, "message": "Missing repo_id"}, status=400)
|
||||
if not backup_id:
|
||||
return web.json_response({"ok": False, "message": "Missing backup_id"}, status=400)
|
||||
|
||||
try:
|
||||
result = await self.core.restore_repo_backup(repo_id, backup_id)
|
||||
return web.json_response(result, status=200)
|
||||
except Exception as e:
|
||||
_LOGGER.exception("BCS restore failed: %s", e)
|
||||
return web.json_response({"ok": False, "message": str(e) or "Restore failed"}, status=500)
|
||||
|
||||
|
||||
class BCSRestartView(HomeAssistantView):
|
||||
url = "/api/bcs/restart"
|
||||
name = "api:bcs_restart"
|
||||
@@ -370,3 +478,55 @@ class BCSRestartView(HomeAssistantView):
|
||||
except Exception as e:
|
||||
_LOGGER.exception("BCS restart failed: %s", e)
|
||||
return web.json_response({"ok": False, "message": str(e) or "Restart failed"}, status=500)
|
||||
|
||||
class BCSRepoDetailView(HomeAssistantView):
|
||||
url = "/api/bcs/repo"
|
||||
name = "api:bcs_repo"
|
||||
requires_auth = True
|
||||
|
||||
def __init__(self, core: Any) -> None:
|
||||
self.core: BCSCore = core
|
||||
|
||||
async def get(self, request: web.Request) -> web.Response:
|
||||
repo_id = (request.query.get("repo_id") or "").strip()
|
||||
if not repo_id:
|
||||
return web.json_response({"ok": False, "message": "Missing repo_id"}, status=400)
|
||||
|
||||
try:
|
||||
repo = await self.core.ensure_repo_details(repo_id)
|
||||
if not repo:
|
||||
return web.json_response({"ok": False, "message": "Repo not found"}, status=404)
|
||||
|
||||
inst = self.core.get_installed(repo_id) or {}
|
||||
installed = bool(inst)
|
||||
domains = inst.get("domains") or []
|
||||
if not isinstance(domains, list):
|
||||
domains = []
|
||||
|
||||
return web.json_response({
|
||||
"ok": True,
|
||||
"repo": {
|
||||
"id": repo.id,
|
||||
"name": repo.name,
|
||||
"url": repo.url,
|
||||
"source": repo.source,
|
||||
"owner": repo.owner,
|
||||
"provider": repo.provider,
|
||||
"repo_name": repo.provider_repo_name,
|
||||
"description": repo.provider_description or repo.meta_description,
|
||||
"default_branch": repo.default_branch,
|
||||
"latest_version": repo.latest_version,
|
||||
"latest_version_source": repo.latest_version_source,
|
||||
"category": repo.meta_category,
|
||||
"meta_author": repo.meta_author,
|
||||
"meta_maintainer": repo.meta_maintainer,
|
||||
"meta_source": repo.meta_source,
|
||||
"installed": installed,
|
||||
"installed_version": inst.get("installed_version"),
|
||||
"installed_manifest_version": inst.get("installed_manifest_version"),
|
||||
"installed_domains": domains,
|
||||
}
|
||||
}, status=200)
|
||||
except Exception as e:
|
||||
_LOGGER.exception("BCS repo details failed: %s", e)
|
||||
return web.json_response({"ok": False, "message": str(e) or "Repo details failed"}, status=500)
|
||||
|
||||
Reference in New Issue
Block a user