@mp-consulting/homebridge-ui-kit 1.0.0

package/README.md

@@ -0,0 +1,52 @@
+# @mp-consulting/homebridge-ui-kit
+
+Brand design system for [@mp-consulting](https://github.com/mp-consulting) Homebridge plugins.
+
+Provides shared CSS tokens, Bootstrap 5 overrides, and vanilla JS UI components used across all `@mp-consulting` Homebridge plugin config UIs.
+
+## Contents
+
+| File | Description |
+|------|-------------|
+| `dist/kit.css` | CSS tokens, Bootstrap overrides, and shared component styles |
+| `dist/kit.js` | Vanilla JS helpers exposed as `window.MpKit` |
+
+## Usage
+
+Copy the built assets into your plugin's `homebridge-ui/public/lib/` directory and reference them in `index.html`:
+
+```html
+<link rel="stylesheet" href="lib/kit.css">
+<!-- after your app scripts: -->
+<script src="lib/kit.js"></script>
+```
+
+### MpKit API
+
+```js
+// Status badges
+MpKit.StatusBadge.online()    // → HTML string
+MpKit.StatusBadge.offline()
+MpKit.StatusBadge.checking()
+MpKit.StatusBadge.disabled()
+
+// Empty state
+MpKit.EmptyState.render({ iconClass, title, hint })
+
+// Loading placeholder
+MpKit.Loading.render('Loading...')
+
+// View switching (.mp-view elements)
+MpKit.View.show('viewId')
+```
+
+## Development
+
+```bash
+npm install
+npm run build   # outputs to dist/
+```
+
+## License
+
+MIT © MP Consulting

package/dist/kit.css

@@ -0,0 +1,253 @@
+/* @mp-consulting/homebridge-ui-kit v1.0.0 */
+
+/* ── Design tokens ──────────────────────────────────────────────────────────
+   CSS custom properties used throughout the design system.
+   Override these in your plugin's styles.css to customize per-plugin.
+   ────────────────────────────────────────────────────────────────────────── */
+
+:root {
+  /* Brand */
+  --mp-primary: #4f46e5;
+  --mp-primary-rgb: 79, 70, 229;
+  --mp-primary-hover: #4338ca;
+  --mp-primary-subtle: rgba(79, 70, 229, 0.12);
+
+  /* Status */
+  --mp-status-online: #10b981;
+  --mp-status-online-glow: rgba(16, 185, 129, 0.35);
+  --mp-status-offline: #ef4444;
+  --mp-status-checking: #94a3b8;
+
+  /* Surfaces */
+  --mp-surface: rgba(255, 255, 255, 0.03);
+  --mp-border: rgba(255, 255, 255, 0.08);
+
+  /* Shape */
+  --mp-radius: 0.5rem;
+  --mp-shadow-hover: 0 0.5rem 1rem rgba(0, 0, 0, 0.3);
+}
+
+/* ── Bootstrap 5 overrides ──────────────────────────────────────────────────
+   Remap Bootstrap components to use brand tokens.
+   ────────────────────────────────────────────────────────────────────────── */
+
+/* Primary button */
+.btn-primary {
+  --bs-btn-bg: var(--mp-primary);
+  --bs-btn-border-color: var(--mp-primary);
+  --bs-btn-hover-bg: var(--mp-primary-hover);
+  --bs-btn-hover-border-color: var(--mp-primary-hover);
+  --bs-btn-active-bg: var(--mp-primary-hover);
+  --bs-btn-active-border-color: var(--mp-primary-hover);
+  --bs-btn-focus-shadow-rgb: var(--mp-primary-rgb);
+}
+
+/* Primary spinner */
+.spinner-border.text-primary,
+.spinner-grow.text-primary {
+  color: var(--mp-primary) !important;
+}
+
+/* ── Components ─────────────────────────────────────────────────────────────
+   Reusable UI components used across all Homebridge plugins.
+   ────────────────────────────────────────────────────────────────────────── */
+
+/* ── Plugin header ──────────────────────────────────────── */
+
+.mp-header {
+  display: flex;
+  align-items: center;
+  gap: 0.875rem;
+  margin-bottom: 0.5rem;
+}
+
+.mp-header-icon {
+  font-size: 2rem;
+  flex-shrink: 0;
+  line-height: 1;
+}
+
+.mp-header-title {
+  font-size: 1.375rem;
+  font-weight: 600;
+  margin: 0;
+  line-height: 1.3;
+}
+
+.mp-header-subtitle {
+  font-size: 0.875rem;
+  color: var(--bs-secondary-color);
+  margin: 0;
+}
+
+/* ── Status indicator dot ───────────────────────────────── */
+
+.mp-status {
+  width: 8px;
+  height: 8px;
+  border-radius: 50%;
+  display: inline-block;
+  flex-shrink: 0;
+  vertical-align: middle;
+}
+
+.mp-status-online {
+  background-color: var(--mp-status-online);
+  box-shadow: 0 0 5px var(--mp-status-online-glow);
+}
+
+.mp-status-offline {
+  background-color: var(--mp-status-offline);
+}
+
+.mp-status-checking {
+  background-color: var(--mp-status-checking);
+  animation: mp-pulse 1.5s ease-in-out infinite;
+}
+
+@keyframes mp-pulse {
+  0%, 100% { opacity: 1; }
+  50% { opacity: 0.35; }
+}
+
+/* ── Device card ────────────────────────────────────────── */
+
+.mp-device-card {
+  transition: transform 0.15s ease, box-shadow 0.15s ease;
+  cursor: pointer;
+}
+
+.mp-device-card:hover {
+  transform: translateY(-1px);
+  box-shadow: var(--mp-shadow-hover) !important;
+}
+
+/* ── Settings surface card ──────────────────────────────── */
+
+.mp-settings-card {
+  background: var(--mp-surface);
+  border: 1px solid var(--mp-border) !important;
+  border-radius: var(--mp-radius);
+}
+
+/* ── Empty state ────────────────────────────────────────── */
+
+.mp-empty-state {
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+  justify-content: center;
+  padding: 3rem 1.5rem;
+  text-align: center;
+}
+
+.mp-empty-state-icon {
+  font-size: 2.5rem;
+  color: var(--bs-secondary-color);
+  margin-bottom: 0.75rem;
+  line-height: 1;
+}
+
+.mp-empty-state-title {
+  font-size: 0.9375rem;
+  font-weight: 500;
+  color: var(--bs-secondary-color);
+  margin: 0 0 0.25rem;
+}
+
+.mp-empty-state-hint {
+  font-size: 0.8125rem;
+  color: var(--bs-secondary-color);
+  margin: 0;
+  opacity: 0.7;
+}
+
+/* ── Loading state ──────────────────────────────────────── */
+
+.mp-loading {
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+  justify-content: center;
+  padding: 2.5rem 1.5rem;
+  gap: 0.75rem;
+  color: var(--bs-secondary-color);
+  font-size: 0.875rem;
+}
+
+/* ── Nav tabs ───────────────────────────────────────────── */
+
+.mp-tabs {
+  border-bottom: 1px solid var(--mp-border);
+}
+
+.mp-tabs .nav-link {
+  color: var(--bs-secondary-color);
+  border: none;
+  padding: 0.75rem 1.25rem;
+  font-weight: 500;
+}
+
+.mp-tabs .nav-link:hover {
+  color: var(--bs-body-color);
+  border: none;
+}
+
+.mp-tabs .nav-link.active {
+  color: var(--mp-primary);
+  background: transparent;
+  border: none;
+  border-bottom: 2px solid var(--mp-primary);
+}
+
+/* ── Metadata label ─────────────────────────────────────── */
+
+.mp-label {
+  font-size: 0.75rem;
+  text-transform: uppercase;
+  letter-spacing: 0.5px;
+  color: var(--bs-secondary-color);
+}
+
+/* ── View toggling ──────────────────────────────────────── */
+
+.mp-view {
+  display: none;
+}
+
+.mp-view.active {
+  display: block;
+}
+
+/* ── Support footer ─────────────────────────────────────── */
+
+.mp-footer {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  flex-wrap: wrap;
+  gap: 0.75rem 1rem;
+  padding-top: 1.5rem;
+  margin-top: 2rem;
+  border-top: 1px solid var(--mp-border);
+  font-size: 0.8125rem;
+  color: var(--bs-secondary-color);
+}
+
+.mp-footer a {
+  color: var(--bs-secondary-color);
+  text-decoration: none;
+  display: inline-flex;
+  align-items: center;
+  gap: 0.3rem;
+  transition: color 0.15s ease;
+}
+
+.mp-footer a:hover {
+  color: var(--mp-primary);
+}
+
+.mp-footer-sep {
+  color: var(--mp-border);
+  user-select: none;
+}

package/dist/kit.js

@@ -0,0 +1,133 @@
+/* @mp-consulting/homebridge-ui-kit v1.0.0
+   Brand design system for Homebridge plugins
+   https://github.com/mp-consulting/homebridge-ui-kit */
+
+(function (global) {
+  'use strict';
+
+  var MpKit = {
+
+    /**
+     * StatusBadge — returns inline HTML for device status badges.
+     *
+     * MpKit.StatusBadge.online()    → green dot + "Online"
+     * MpKit.StatusBadge.offline()   → red dot + "Offline"
+     * MpKit.StatusBadge.checking()  → animated dot + "Checking..."
+     * MpKit.StatusBadge.disabled()  → grey badge + "Disabled"
+     */
+    StatusBadge: {
+      online: function (label) {
+        label = label || 'Online';
+        return '<span class="badge bg-success-subtle text-success">'
+          + '<span class="mp-status mp-status-online me-1"></span>'
+          + label + '</span>';
+      },
+      offline: function (label) {
+        label = label || 'Offline';
+        return '<span class="badge bg-danger-subtle text-danger">'
+          + '<span class="mp-status mp-status-offline me-1"></span>'
+          + label + '</span>';
+      },
+      checking: function (label) {
+        label = label || 'Checking...';
+        return '<span class="badge bg-secondary-subtle text-secondary">'
+          + '<span class="mp-status mp-status-checking me-1"></span>'
+          + label + '</span>';
+      },
+      disabled: function (label) {
+        label = label || 'Disabled';
+        return '<span class="badge bg-secondary">' + label + '</span>';
+      },
+    },
+
+    /**
+     * EmptyState — returns HTML for an empty list placeholder.
+     *
+     * MpKit.EmptyState.render({
+     *   iconClass: 'bi bi-lightbulb',
+     *   title: 'No devices found',
+     *   hint: 'Click Discover to scan your network',
+     * })
+     */
+    EmptyState: {
+      render: function (opts) {
+        opts = opts || {};
+        var icon = opts.iconClass || 'bi bi-inbox';
+        var title = opts.title || 'No items';
+        var hint = opts.hint || '';
+        return '<div class="mp-empty-state">'
+          + '<i class="' + icon + ' mp-empty-state-icon"></i>'
+          + '<p class="mp-empty-state-title">' + title + '</p>'
+          + (hint ? '<p class="mp-empty-state-hint">' + hint + '</p>' : '')
+          + '</div>';
+      },
+    },
+
+    /**
+     * Loading — returns HTML for a centred loading spinner with message.
+     *
+     * MpKit.Loading.render('Loading device information...')
+     */
+    Loading: {
+      render: function (message) {
+        message = message || 'Loading...';
+        return '<div class="mp-loading">'
+          + '<div class="spinner-border spinner-border-sm text-secondary" role="status" aria-hidden="true"></div>'
+          + '<span>' + message + '</span>'
+          + '</div>';
+      },
+    },
+
+    /**
+     * View — controls which .mp-view element is visible.
+     *
+     * MpKit.View.show('listView')     → shows #listView, hides all others
+     * MpKit.View.show('settingsView') → shows #settingsView, hides all others
+     */
+    View: {
+      show: function (id) {
+        document.querySelectorAll('.mp-view').forEach(function (v) {
+          v.classList.remove('active');
+        });
+        var el = document.getElementById(id);
+        if (el) { el.classList.add('active'); }
+      },
+    },
+
+    /**
+     * Footer — renders support links into a .mp-footer element.
+     *
+     * MpKit.Footer.render({
+     *   github: 'https://github.com/mp-consulting/homebridge-...',
+     *   npm: 'https://www.npmjs.com/package/@mp-consulting/...',
+     *   changelog: 'https://github.com/.../blob/main/CHANGELOG.md',
+     * })
+     */
+    Footer: {
+      render: function (opts) {
+        opts = opts || {};
+        var target = opts.target || '.mp-footer';
+        var el = typeof target === 'string' ? document.querySelector(target) : target;
+        if (!el) { return; }
+        var links = [];
+        if (opts.github) {
+          links.push('<a href="' + opts.github + '" target="_blank" rel="noopener">'
+            + '<i class="bi bi-github"></i>GitHub</a>');
+        }
+        if (opts.npm) {
+          links.push('<a href="' + opts.npm + '" target="_blank" rel="noopener">'
+            + '<i class="bi bi-box-seam"></i>npm</a>');
+        }
+        if (opts.changelog) {
+          links.push('<a href="' + opts.changelog + '" target="_blank" rel="noopener">'
+            + '<i class="bi bi-clock-history"></i>Changelog</a>');
+        }
+        el.innerHTML = links.join('<span class="mp-footer-sep">|</span>');
+      },
+    },
+
+  };
+
+  global.MpKit = MpKit;
+
+})(window);

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@mp-consulting/homebridge-ui-kit",
+  "version": "1.0.0",
+  "description": "Brand design system for @mp-consulting Homebridge plugins",
+  "author": "MP Consulting",
+  "license": "MIT",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mp-consulting/homebridge-ui-kit.git"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "node scripts/build.js"
+  }
+}