@inradius/solid-wc-hass-mixin 0.0.2 → 0.0.4

package/README.md

@@ -1,62 +1,62 @@
-# @inradius/solid-wc-hass-mixin
-![npm version](https://img.shields.io/npm/v/@inradius/solid-wc-hass-mixin) ![license](https://img.shields.io/npm/l/@inradius/solid-wc-hass-mixin)
-
-A lightweight mixin for [component-register](https://www.npmjs.com/package/component-register) that streamlines the creation of Home Assistant Custom Cards using Solid.js.
-
-This mixin automatically handles the boilerplate required by Home Assistant, including `setConfig`, card registration in the global window object, and the `getCardSize` method.
-
-## Features
-- **Automatic Registration:** Automatically pushes your card configuration to the Home Assistant `customCards` registry.
-- **Config Handling:** Implements `setConfig` and merges your `defaultConfig` with user-provided settings.
-- **TypeScript Ready:** Full type safety for Home Assistant card configurations.
-- **Clean Integration:** Designed to work seamlessly with `compose` and `register`.
-
-```bash
-npm install @inradius/solid-wc-hass-mixin component-register
-# or
-pnpm add @inradius/solid-wc-hass-mixin component-register
-```
-
-## Usage
-Use `withHomeAssistant` within your `compose` pipeline. It should wrap your final component ***before*** registration.
-
-```typescript
-import { register, compose, withSolid } from 'component-register';
-import withHomeAssistant from '@inradius/solid-wc-hass-mixin';
-import { MyApp } from './MyApp';
-
-compose(
-  withHomeAssistant({
-    defaultConfig: {
-      name: 'My Card',
-      layout: 'vertical',
-    },
-    customCard: {
-      type: 'my-custom-card',
-      name: 'My Custom Card',
-      description: 'A beautiful Solid.js card for Home Assistant.',
-      preview: true
-    },
-    cardSize: 3
-  }),
-  register('my-custom-card'),
-  withSolid
-)(MyApp);
-```
-
-### Options
-The `withHomeAssistant` function accepts an options object:
-
-| Property | Type | Default | Description |
-| --- | --- | --- | --- |
-| customCard | CustomCardEntry | Required | The metadata used by the Home Assistant UI picker. |
-| defaultConfig | Record<string, unknown> | {} | Default values for your card's YAML configuration. |
-| cardSize | number | 3 | The height of the card in the Home Assistant grid. |
-
-## How it works
-1. `setConfig(config)`: Home Assistant calls this when the UI editor changes. This mixin ensures a valid config is provided and attaches it to `this.config`.
-2. `getCardSize()`: Returns the specified grid height for the Home Assistant dashboard.
-3. Global Registry: Adds your card to `window.customCards` so it appears in the "Add Card" dialog in the Lovelace UI.
-
-## License
+# @inradius/solid-wc-hass-mixin
+![npm version](https://img.shields.io/npm/v/@inradius/solid-wc-hass-mixin) ![license](https://img.shields.io/npm/l/@inradius/solid-wc-hass-mixin)
+
+A lightweight mixin for [component-register](https://www.npmjs.com/package/component-register) that streamlines the creation of Home Assistant Custom Cards using Solid.js.
+
+This mixin automatically handles the boilerplate required by Home Assistant, including `setConfig`, card registration in the global window object, and the `getCardSize` method.
+
+## Features
+- **Automatic Registration:** Automatically pushes your card configuration to the Home Assistant `customCards` registry.
+- **Config Handling:** Implements `setConfig` and merges your `defaultConfig` with user-provided settings.
+- **TypeScript Ready:** Full type safety for Home Assistant card configurations.
+- **Clean Integration:** Designed to work seamlessly with `compose` and `register`.
+
+```bash
+npm install @inradius/solid-wc-hass-mixin component-register
+# or
+pnpm add @inradius/solid-wc-hass-mixin component-register
+```
+
+## Usage
+Use `withHomeAssistant` within your `compose` pipeline. It should wrap your final component ***before*** registration.
+
+```typescript
+import { register, compose, withSolid } from 'component-register';
+import withHomeAssistant from '@inradius/solid-wc-hass-mixin';
+import { MyApp } from './MyApp';
+
+compose(
+  withHomeAssistant({
+    defaultConfig: {
+      name: 'My Card',
+      layout: 'vertical',
+    },
+    customCard: {
+      type: 'my-custom-card',
+      name: 'My Custom Card',
+      description: 'A beautiful Solid.js card for Home Assistant.',
+      preview: true
+    },
+    cardSize: 3
+  }),
+  register('my-custom-card'),
+  withSolid
+)(MyApp);
+```
+
+### Options
+The `withHomeAssistant` function accepts an options object:
+
+| Property | Type | Default | Description |
+| --- | --- | --- | --- |
+| customCard | CustomCardEntry | Required | The metadata used by the Home Assistant UI picker. |
+| defaultConfig | Record<string, unknown> | {} | Default values for your card's YAML configuration. |
+| cardSize | number | 3 | The height of the card in the Home Assistant grid. |
+
+## How it works
+1. `setConfig(config)`: Home Assistant calls this when the UI editor changes. This mixin ensures a valid config is provided and attaches it to `this.config`.
+2. `getCardSize()`: Returns the specified grid height for the Home Assistant dashboard.
+3. Global Registry: Adds your card to `window.customCards` so it appears in the "Add Card" dialog in the Lovelace UI.
+
+## License
 MIT © Travis

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";const a=n=>{const{defaultConfig:i={},customCard:c,cardSize:u=3}=n;return o=>{const r=o.prototype,t=window;return t.customCards=t.customCards||[],r.setConfig=function(s){if(!s)throw new Error("Invalid configuration");this.config={...i,...s}},r.getCardSize=function(){return u},t.customCards.push({...c}),o}};module.exports=a;
+"use strict";const u=new Set(["__proto__","constructor","prototype"]),n=r=>Object.fromEntries(Object.entries(r).filter(([o])=>!u.has(o))),d=r=>{const{cardSize:o=3,customCard:c,defaultConfig:a={}}=r;return e=>{const i=e.prototype,s=window;return s.customCards=s.customCards||[],i.setConfig=function(t){if(!t||typeof t!="object"||Array.isArray(t))throw new Error("Invalid configuration");this.config={...n(a),...n(t)}},i.getCardSize=function(){return o},s.customCards.push(n(c)),e}};module.exports=d;

package/dist/index.d.ts

@@ -1,19 +1,5 @@
 import { ComponentType } from 'component-register';
-export interface LovelaceCardConfig {
-    type: string;
-    [key: string]: unknown;
-}
-export interface CustomCardEntry {
-    type: string;
-    name: string;
-    description: string;
-    preview?: boolean;
-}
-export interface HomeAssistantOptions {
-    defaultConfig?: Record<string, unknown>;
-    customCard: CustomCardEntry;
-    cardSize?: number;
-}
+import { HomeAssistantOptions } from './types';
 declare const withHomeAssistant: (options: HomeAssistantOptions) => <T>(ElementType: ComponentType<T>) => ComponentType<T>;
 export default withHomeAssistant;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAExD,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACxC,UAAU,EAAE,eAAe,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAQD,QAAA,MAAM,iBAAiB,GAAI,SAAS,oBAAoB,MAG9C,CAAC,EAAE,aAAa,aAAa,CAAC,CAAC,CAAC,KAAG,aAAa,CAAC,CAAC,CAqB3D,CAAC;AAEF,eAAe,iBAAiB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAEL,oBAAoB,EAErB,MAAM,SAAS,CAAC;AASjB,QAAA,MAAM,iBAAiB,GAAI,SAAS,oBAAoB,MAG9C,CAAC,EAAE,aAAa,aAAa,CAAC,CAAC,CAAC,KAAG,aAAa,CAAC,CAAC,CAqB3D,CAAC;AAEF,eAAe,iBAAiB,CAAC"}

package/dist/index.js

@@ -1,16 +1,18 @@
-const c = (s) => {
-  const { defaultConfig: i = {}, customCard: u, cardSize: a = 3 } = s;
-  return (o) => {
-    const r = o.prototype, t = window;
-    return t.customCards = t.customCards || [], r.setConfig = function(n) {
-      if (!n)
+const u = /* @__PURE__ */ new Set(["__proto__", "constructor", "prototype"]), n = (o) => Object.fromEntries(
+  Object.entries(o).filter(([r]) => !u.has(r))
+), d = (o) => {
+  const { cardSize: r = 3, customCard: c, defaultConfig: a = {} } = o;
+  return (e) => {
+    const i = e.prototype, s = window;
+    return s.customCards = s.customCards || [], i.setConfig = function(t) {
+      if (!t || typeof t != "object" || Array.isArray(t))
         throw new Error("Invalid configuration");
-      this.config = { ...i, ...n };
-    }, r.getCardSize = function() {
-      return a;
-    }, t.customCards.push({ ...u }), o;
+      this.config = { ...n(a), ...n(t) };
+    }, i.getCardSize = function() {
+      return r;
+    }, s.customCards.push(n(c)), e;
   };
 };
 export {
-  c as default
+  d as default
 };

package/dist/types.d.ts

@@ -0,0 +1,22 @@
+export interface CustomCardEntry {
+    [key: string]: unknown;
+    description: string;
+    name: string;
+    preview?: boolean;
+    type: string;
+}
+export interface HomeAssistantElement extends HTMLElement {
+    config?: LovelaceCardConfig;
+    getCardSize(): number;
+    setConfig(config: LovelaceCardConfig): void;
+}
+export interface HomeAssistantOptions {
+    cardSize?: number;
+    customCard: CustomCardEntry;
+    defaultConfig?: Record<string, unknown>;
+}
+export interface LovelaceCardConfig {
+    [key: string]: unknown;
+    type: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAC9B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,oBAAqB,SAAQ,WAAW;IACvD,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAC5B,WAAW,IAAI,MAAM,CAAC;IACtB,SAAS,CAAC,MAAM,EAAE,kBAAkB,GAAG,IAAI,CAAC;CAC7C;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,eAAe,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACzC;AAED,MAAM,WAAW,kBAAkB;IACjC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;CACd"}

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@inradius/solid-wc-hass-mixin",
   "author": "Travis Stroud <travis.unfasten577@travisstroud.me>",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "A Solid.js Home Assistant web component mixin.",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/inradius/solid-wc-utils-monorepo.git",
     "directory": "packages/solid-wc-hass-mixin"
   },
+  "homepage": "https://github.com/inradius/solid-wc-utils-monorepo/tree/main/packages/solid-wc-hass-mixin#readme",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -23,9 +24,14 @@
     "dist"
   ],
   "devDependencies": {
+    "@vitest/coverage-v8": "^2.1.9",
+    "@vitest/ui": "^2.1.0",
+    "jsdom": "^28.1.0",
     "rimraf": "^6.0.0",
     "vite": "^5.4.0",
-    "vite-plugin-dts": "^4.0.0"
+    "vite-plugin-dts": "^4.0.0",
+    "vitest": "^2.1.0",
+    "@inradius/solid-wc-utils-config": "0.0.0"
   },
   "peerDependencies": {
     "component-register": "^0.8.0"
@@ -34,6 +40,10 @@
   "scripts": {
     "build": "vite build",
     "dev": "vite build --watch",
-    "clean": "rimraf dist"
+    "clean": "rimraf dist",
+    "lint": "eslint src",
+    "lint:fix": "eslint src --fix",
+    "test": "vitest run --coverage",
+    "test:watch": "vitest"
   }
 }