@serve.zone/catalog

@serve.zone/catalog is the shared web-component catalog for serve.zone dashboards. It packages the UI building blocks used by Onebox, DcRouter-style operations views, and other serve.zone admin surfaces: dashboards, service views, app-store screens, DNS and routing tools, registry panels, email views, settings, tokens, and demo shells.

Issue Reporting and Security

For reporting bugs, issues, or security vulnerabilities, please visit community.foss.global/. This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a code.foss.global/ account to submit Pull Requests directly.

Install

pnpm add @serve.zone/catalog

What It Provides

The package exports browser-first TypeScript modules from ts_web/index.ts:

export * from './elements/index.js';
export * from './pages/index.js';

Importing a component registers its custom element through @design.estate/dees-element decorators. Components use the Dees design system, support light and dark themes through Dees theme helpers, and communicate through DOM properties plus CustomEvent dispatching.

import {
  SzDashboardView,
  SzLoginView,
  SzServiceDetailView,
} from '@serve.zone/catalog';

<sz-dashboard-view></sz-dashboard-view>
<sz-login-view></sz-login-view>
<sz-service-detail-view></sz-service-detail-view>

Component Areas

| Area | Components | | --- | --- | | Dashboard | SzDashboardView, SzResourceUsageCard, SzTrafficCard, SzPlatformServicesCard, SzCertificatesCard, SzReverseProxyCard, SzDnsSslCard, SzQuickActionsCard, and status-grid components. | | Services | SzServicesListView, SzServiceDetailView, SzServiceCreateView, SzServicesBackupsView, and SzAppStoreView. | | Network and domains | SzNetworkProxyView, SzNetworkDnsView, SzNetworkDomainsView, and SzDomainDetailView. | | Routes | SzRouteListView, SzRouteCard, and SzInputRouteSourcePolicy for route configuration, match criteria, actions, TLS mode, source bindings, and route-level source policy editing. | | Mail | SzMtaListView and SzMtaDetailView for inbound/outbound email operations views. | | Registries | SzRegistryAdvertisement and SzRegistryExternalView. | | Auth and settings | SzLoginView, SzTokensView, and SzSettingsView. | | Configuration | SzConfigOverview and SzConfigSection. | | Demo pages | SzDemoAppShell, SzDemoApp, Mainpage, and SzDemoView* components used by the development/demo environment. |

The exported catalog currently contains more than 30 product UI components plus demo orchestration components. Prefer the exported barrel imports over deep file imports unless you are working inside this repository.

Usage Patterns

Most components expose data through typed properties and emit actions as DOM events.

import { html } from '@design.estate/dees-element';
import '@serve.zone/catalog';

const dashboardTemplate = html`
  <sz-dashboard-view
    .data=${dashboardData}
    @action-click=${(event: CustomEvent) => {
      console.log('dashboard action selected', event.detail);
    }}
  ></sz-dashboard-view>
`;

<sz-mta-list-view> accepts emails, a controlled searchQuery, and stickyFilterBar. Search input emits a bubbling, composed search-change event with { searchQuery }. Consumers can place related context such as a traffic chart between the filters and the email table through the above-table slot.

const emailLogTemplate = html`
  <sz-mta-list-view
    .emails=${emails}
    .searchQuery=${searchQuery}
    .stickyFilterBar=${true}
    @search-change=${(event: CustomEvent<{ searchQuery: string }>) => {
      searchQuery = event.detail.searchQuery;
    }}
  >
    <dees-chart-area slot="above-table"></dees-chart-area>
  </sz-mta-list-view>
`;

<sz-mta-detail-view> renders inbound SPF, DKIM, and DMARC results. For outbound mail it renders the recorded self-check over the exact signed message and actual egress source. The panel is present before the first delivery attempt, distinguishes waiting and unrecorded evidence from real pending, completed, indeterminate, and not-evaluated checks, and explicitly describes the result as a prediction rather than a destination receipt.

For a full app-style demo shell with navigation, import the package and render <sz-demo-app-shell>:

<sz-demo-app-shell></sz-demo-app-shell>

The demo shell is useful for development and visual review. Production apps usually compose the lower-level components into their own routing and data-fetching layer.

Route policy editors can use <sz-input-route-source-policy> as a dees-form compatible input. It accepts available source profiles, optional path-class metadata, and preset policies, then returns normalized IRouteSourceBinding[] data through getValue() or form collection.

Protection controls in source bindings and path policies use tri-state semantics:

• omit rateLimit or challenge to inherit the effective source-profile or parent policy default
• set rateLimit: null or challenge: null to explicitly clear an inherited control for that scope
• set an object to apply a custom rate limit or browser challenge

For custom rate limits, the editor exposes a When exceeded selector. Return 429 stores normal rate limiting behavior. Browser challenge stores the challenge on rateLimit.onExceeded, not on the binding-level onExceeded field.

import type {
  IRoutePathClassOption,
  IRouteSourceBinding,
  ISourceProfileOption,
} from '@serve.zone/catalog';

const sourceProfiles: ISourceProfileOption[] = [
  { id: 'trusted-profile', name: 'Trusted Networks', hasSourceMatches: true },
  { id: 'public-profile', name: 'Public', hasSourceMatches: true, matchesAllSources: true },
];

const pathClassOptions: IRoutePathClassOption[] = [
  { key: 'normal-html', label: 'Normal HTML' },
];

const bindings: IRouteSourceBinding[] = [
  {
    sourceProfileRef: 'trusted-profile',
    rateLimit: null,
    onExceeded: { type: '429' },
  },
  {
    sourceProfileRef: 'public-profile',
    rateLimit: {
      enabled: true,
      maxRequests: 120,
      window: 60,
      keyBy: 'ip',
      onExceeded: {
        type: 'challenge',
        challenge: {
          providerId: 'smartchallenge',
          challengeType: 'wait',
          clearance: { ttlSeconds: 300, bindToHost: true },
        },
        clearanceEffect: 'bypass-rate-limit',
      },
    },
    onExceeded: { type: '429' },
  },
];

<sz-input-route-source-policy key="sourcePolicy"></sz-input-route-source-policy>

TypeScript Interfaces

Many components export their own data interfaces alongside the custom element class. These interfaces are intended for UI-facing view models, not as replacements for backend contracts from @serve.zone/interfaces.

import type {
  IDashboardData,
  IRouteConfig,
  IRoutePathClassOption,
  IRouteSourceBinding,
  IServiceDetail,
  ISourceProfileOption,
  IAppTemplate,
} from '@serve.zone/catalog';

Use these types to shape component props in the frontend. Use @serve.zone/interfaces for API and persisted platform contracts.

Architecture

The catalog follows a consistent component pattern:

import {
  DeesElement,
  css,
  cssManager,
  customElement,
  html,
  property,
} from '@design.estate/dees-element';

@customElement('sz-example-card')
export class SzExampleCard extends DeesElement {
  @property({ type: String })
  public accessor label = '';

  public static styles = [
    cssManager.defaultStyles,
    css`
      :host {
        color: ${cssManager.bdTheme('#18181b', '#fafafa')};
      }
    `,
  ];

  public render() {
    return html`<span>${this.label}</span>`;
  }
}

Project layout:

@serve.zone/catalog/
├── html/                 # WccTools dev server shell
├── ts_web/
│   ├── index.ts          # package barrel export
│   ├── elements/         # reusable sz-* web components
│   └── pages/            # demo app and shell pages
└── dist_ts_web/          # compiled npm entry point

Development

pnpm install
pnpm run watch
pnpm run build
pnpm test

pnpm run watch starts the WccTools development environment for browsing the catalog with demo data. pnpm run build compiles TypeScript folders and creates the browser bundle with tsbundle.

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 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.

Trademarks

This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.

Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.

Company Information

Task Venture Capital GmbH Registered at District Court Bremen HRB 35230 HB, Germany

For any legal inquiries or further information, please contact us via email at [email protected].

By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.