feat(docs): document newly available catalog components and updated build configuration details
This commit is contained in:
@@ -1,5 +1,12 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## 2026-04-02 - 2.10.0 - feat(docs)
|
||||||
|
document newly available catalog components and updated build configuration details
|
||||||
|
|
||||||
|
- Update component counts and add documentation for App Store, Routes, MTA/Email, and Configuration views
|
||||||
|
- Expand the README with new component tables and exported TypeScript types
|
||||||
|
- Refresh build notes to reference .smartconfig.json and the renamed config file
|
||||||
|
|
||||||
## 2026-04-02 - 2.9.1 - fix(build)
|
## 2026-04-02 - 2.9.1 - fix(build)
|
||||||
migrate build configuration to .smartconfig and update toolchain dependencies
|
migrate build configuration to .smartconfig and update toolchain dependencies
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
## Project Structure
|
## Project Structure
|
||||||
- `html/index.ts` - WccTools setup with sections for Pages and Elements
|
- `html/index.ts` - WccTools setup with sections for Pages and Elements
|
||||||
- `ts_web/elements/` - All web components (27 elements + 6 demo-view wrappers)
|
- `ts_web/elements/` - All web components (34 elements + 9 demo-view wrappers)
|
||||||
- `ts_web/elements/index.ts` - Barrel export for all element components
|
- `ts_web/elements/index.ts` - Barrel export for all element components
|
||||||
- `ts_web/pages/` - Page components
|
- `ts_web/pages/` - Page components
|
||||||
|
|
||||||
@@ -20,9 +20,14 @@
|
|||||||
| Dashboard Grids | sz-status-grid-cluster, sz-status-grid-services, sz-status-grid-network, sz-status-grid-infra |
|
| Dashboard Grids | sz-status-grid-cluster, sz-status-grid-services, sz-status-grid-network, sz-status-grid-infra |
|
||||||
| Platform | sz-platform-services-card, sz-platform-service-detail-view |
|
| Platform | sz-platform-services-card, sz-platform-service-detail-view |
|
||||||
| Network | sz-network-proxy-view, sz-network-dns-view, sz-network-domains-view, sz-reverse-proxy-card, sz-dns-ssl-card, sz-certificates-card, sz-domain-detail-view |
|
| Network | sz-network-proxy-view, sz-network-dns-view, sz-network-domains-view, sz-reverse-proxy-card, sz-dns-ssl-card, sz-certificates-card, sz-domain-detail-view |
|
||||||
|
| Routes | sz-route-list-view, sz-route-card |
|
||||||
| Services | sz-services-list-view, sz-services-backups-view, sz-service-detail-view, sz-service-create-view |
|
| Services | sz-services-list-view, sz-services-backups-view, sz-service-detail-view, sz-service-create-view |
|
||||||
|
| App Store | sz-app-store-view |
|
||||||
|
| MTA / Email | sz-mta-list-view, sz-mta-detail-view |
|
||||||
|
| Configuration | sz-config-overview, sz-config-section |
|
||||||
| Auth & Settings | sz-login-view, sz-tokens-view, sz-settings-view, sz-registry-advertisement, sz-registry-external-view |
|
| Auth & Settings | sz-login-view, sz-tokens-view, sz-settings-view, sz-registry-advertisement, sz-registry-external-view |
|
||||||
|
|
||||||
## Build
|
## Build
|
||||||
- `pnpm run build` - tsbuild tsfolders + tsbundle element --production
|
- `pnpm run build` - tsbuild tsfolders + tsbundle (reads from .smartconfig.json)
|
||||||
- `pnpm run watch` - starts wcctools dev server
|
- `pnpm run watch` - starts wcctools dev server
|
||||||
|
- Config file: `.smartconfig.json` (renamed from npmextra.json)
|
||||||
|
|||||||
47
readme.md
47
readme.md
@@ -14,15 +14,19 @@ For reporting bugs, issues, or security vulnerabilities, please visit [community
|
|||||||
|
|
||||||
## 🚀 What It Does
|
## 🚀 What It Does
|
||||||
|
|
||||||
`@serve.zone/catalog` provides **30+ production-ready web components** covering every aspect of server management:
|
`@serve.zone/catalog` provides **34 production-ready web components** covering every aspect of server management:
|
||||||
|
|
||||||
- 📊 **Dashboard** — Real-time cluster overview, resource usage, traffic metrics, quick actions
|
- 📊 **Dashboard** — Real-time cluster overview, resource usage, traffic metrics, quick actions
|
||||||
- 🐳 **Services** — Docker container management, deployment, logs, live stats, backups, and an integrated IDE workspace
|
- 🐳 **Services** — Docker container management, deployment, logs, live stats, backups, and an integrated IDE workspace
|
||||||
|
- 🛒 **App Store** — Browse and deploy pre-configured application templates (WordPress, Gitea, etc.)
|
||||||
- 🌐 **Network** — Reverse proxy configuration, DNS record management, domain & SSL certificate monitoring
|
- 🌐 **Network** — Reverse proxy configuration, DNS record management, domain & SSL certificate monitoring
|
||||||
|
- 🔀 **Routes** — SmartProxy route configuration, match criteria, TLS modes, security profiles, forwarding targets
|
||||||
|
- 📧 **MTA / Email** — Inbound and outbound email management, SMTP transaction logs, authentication results
|
||||||
- 📦 **Registries** — Container registry management (onebox + external registries like Docker Hub, GHCR, ECR)
|
- 📦 **Registries** — Container registry management (onebox + external registries like Docker Hub, GHCR, ECR)
|
||||||
- 🔑 **Auth** — Login view, API token management (global + CI tokens)
|
- 🔑 **Auth** — Login view, API token management (global + CI tokens)
|
||||||
- ⚙️ **Settings** — Appearance, Cloudflare integration, SSL/TLS config, network settings, account management
|
- ⚙️ **Settings** — Appearance, Cloudflare integration, SSL/TLS config, network settings, account management
|
||||||
- 🏗️ **Platform Services** — MongoDB, MinIO, ClickHouse, Redis, Caddy monitoring and control
|
- 🏗️ **Platform Services** — MongoDB, MinIO, ClickHouse, Redis, Caddy monitoring and control
|
||||||
|
- 📋 **Configuration** — Read-only overview of the running server configuration with collapsible sections
|
||||||
|
|
||||||
Every component supports **light and dark themes** out of the box and communicates via standard `CustomEvent` dispatching.
|
Every component supports **light and dark themes** out of the box and communicates via standard `CustomEvent` dispatching.
|
||||||
|
|
||||||
@@ -85,6 +89,12 @@ import '@serve.zone/catalog';
|
|||||||
| `SzServiceCreateView` | `<sz-service-create-view>` | Service deployment form — image, ports, env vars, volumes, resource limits |
|
| `SzServiceCreateView` | `<sz-service-create-view>` | Service deployment form — image, ports, env vars, volumes, resource limits |
|
||||||
| `SzServicesBackupsView` | `<sz-services-backups-view>` | Backup schedule and backup history management |
|
| `SzServicesBackupsView` | `<sz-services-backups-view>` | Backup schedule and backup history management |
|
||||||
|
|
||||||
|
### App Store
|
||||||
|
|
||||||
|
| Component | Tag | Description |
|
||||||
|
|-----------|-----|-------------|
|
||||||
|
| `SzAppStoreView` | `<sz-app-store-view>` | App marketplace for deploying pre-configured templates (WordPress, Gitea, etc.) with category filtering |
|
||||||
|
|
||||||
### Platform Services
|
### Platform Services
|
||||||
|
|
||||||
| Component | Tag | Description |
|
| Component | Tag | Description |
|
||||||
@@ -104,6 +114,20 @@ import '@serve.zone/catalog';
|
|||||||
| `SzDnsSslCard` | `<sz-dns-ssl-card>` | Cloudflare DNS and ACME config status |
|
| `SzDnsSslCard` | `<sz-dns-ssl-card>` | Cloudflare DNS and ACME config status |
|
||||||
| `SzCertificatesCard` | `<sz-certificates-card>` | Certificate status counts — valid, expiring, expired |
|
| `SzCertificatesCard` | `<sz-certificates-card>` | Certificate status counts — valid, expiring, expired |
|
||||||
|
|
||||||
|
### Routes
|
||||||
|
|
||||||
|
| Component | Tag | Description |
|
||||||
|
|-----------|-----|-------------|
|
||||||
|
| `SzRouteListView` | `<sz-route-list-view>` | Route configuration list with type filtering (HTTPS, email, DNS, etc.) |
|
||||||
|
| `SzRouteCard` | `<sz-route-card>` | Single route card — match criteria, action type, TLS mode, targets, security profile |
|
||||||
|
|
||||||
|
### MTA / Email
|
||||||
|
|
||||||
|
| Component | Tag | Description |
|
||||||
|
|-----------|-----|-------------|
|
||||||
|
| `SzMtaListView` | `<sz-mta-list-view>` | Email management — inbound/outbound messages with status badges and filtering |
|
||||||
|
| `SzMtaDetailView` | `<sz-mta-detail-view>` | Email detail — SMTP transaction log, TLS info, SPF/DKIM/DMARC results, headers, body |
|
||||||
|
|
||||||
### Registries
|
### Registries
|
||||||
|
|
||||||
| Component | Tag | Description |
|
| Component | Tag | Description |
|
||||||
@@ -119,6 +143,13 @@ import '@serve.zone/catalog';
|
|||||||
| `SzTokensView` | `<sz-tokens-view>` | API token management — global and CI tokens with copy/regenerate/delete |
|
| `SzTokensView` | `<sz-tokens-view>` | API token management — global and CI tokens with copy/regenerate/delete |
|
||||||
| `SzSettingsView` | `<sz-settings-view>` | Full settings panel — appearance, Cloudflare, SSL/TLS, network, account |
|
| `SzSettingsView` | `<sz-settings-view>` | Full settings panel — appearance, Cloudflare, SSL/TLS, network, account |
|
||||||
|
|
||||||
|
### Configuration
|
||||||
|
|
||||||
|
| Component | Tag | Description |
|
||||||
|
|-----------|-----|-------------|
|
||||||
|
| `SzConfigOverview` | `<sz-config-overview>` | Top-level configuration overview with informational banner |
|
||||||
|
| `SzConfigSection` | `<sz-config-section>` | Collapsible config section — icon, enabled/disabled badge, key-value fields, action buttons |
|
||||||
|
|
||||||
## 🏗️ Architecture
|
## 🏗️ Architecture
|
||||||
|
|
||||||
### Component Pattern
|
### Component Pattern
|
||||||
@@ -186,8 +217,20 @@ import type { IServiceDetail, IServiceStats, ILogEntry, IServiceBackup } from '@
|
|||||||
// Network
|
// Network
|
||||||
import type { IDomainDetail, ICertificateDetail, IDnsRecord, ITrafficTarget } from '@serve.zone/catalog';
|
import type { IDomainDetail, ICertificateDetail, IDnsRecord, ITrafficTarget } from '@serve.zone/catalog';
|
||||||
|
|
||||||
|
// Routes
|
||||||
|
import type { IRouteConfig, IRouteMatch, IRouteAction, IRouteTls, IRouteSecurity } from '@serve.zone/catalog';
|
||||||
|
|
||||||
|
// MTA / Email
|
||||||
|
import type { IEmail, IEmailDetail, ISmtpLogEntry, IConnectionInfo, IAuthenticationResults } from '@serve.zone/catalog';
|
||||||
|
|
||||||
|
// Configuration
|
||||||
|
import type { IConfigField, IConfigSectionAction } from '@serve.zone/catalog';
|
||||||
|
|
||||||
// Settings & Auth
|
// Settings & Auth
|
||||||
import type { ISettings, IToken, IExternalRegistry } from '@serve.zone/catalog';
|
import type { ISettings, IToken, IExternalRegistry } from '@serve.zone/catalog';
|
||||||
|
|
||||||
|
// App Store
|
||||||
|
import type { IAppTemplate } from '@serve.zone/catalog';
|
||||||
```
|
```
|
||||||
|
|
||||||
## 🛠️ Development
|
## 🛠️ Development
|
||||||
@@ -210,7 +253,7 @@ The **wcctools dev server** provides an interactive dashboard where every compon
|
|||||||
|
|
||||||
## License and Legal Information
|
## License and Legal Information
|
||||||
|
|
||||||
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](./LICENSE) file.
|
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [license](./license) file.
|
||||||
|
|
||||||
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
|||||||
@@ -3,6 +3,6 @@
|
|||||||
*/
|
*/
|
||||||
export const commitinfo = {
|
export const commitinfo = {
|
||||||
name: '@serve.zone/catalog',
|
name: '@serve.zone/catalog',
|
||||||
version: '2.9.1',
|
version: '2.10.0',
|
||||||
description: 'UI component catalog for serve.zone'
|
description: 'UI component catalog for serve.zone'
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user