Feature/3.1.5 (shannonhochkins#127)

* refactoring

* Update README.md

* adding code of conduct

* Update README.md

* Update README.md

* Will cleanup after npm upgrade has worked

* Dumb storybook fixed

* removing dead code

* Refactoring core and components for tree shaking

* updating after revision

Author: shannonhochkins

.d.ts

@@ -1,12 +1,19 @@
-declare module '*.svg' {
+declare module '*.png' {
   const value: any;
   export = value;
 }
+
 declare module '*.jpg' {
-  const value: any;
+  const value: string;
   export = value;
 }
-declare module '*.npg' {
-  const value: any;
-  export = value;
+
+declare module "*.svg?react" {
+  import * as React from "react";
+
+  const ReactComponent: React.FunctionComponent<
+    React.ComponentProps<"svg"> & { title?: string }
+  >;
+
+  export default ReactComponent;
 }

.nvmrc

@@ -1 +1 @@
-18
+20

.storybook/main.ts

@@ -30,9 +30,6 @@ export default ({
   docs: {
     autodocs: 'tag'
   },
-  features: {
-    storyStoreV7: true
-  },
   typescript: {
     check: true,
     reactDocgen: 'react-docgen-typescript',

.storybook/manager.ts

@@ -1,15 +1,14 @@
 import { create } from '@storybook/theming/create';
+import { addons } from '@storybook/manager-api';
 
 const theme = create({
     base: 'dark',
     brandUrl: 'https://www.npmjs.com/package/@hakit/core',
     brandImage: process.env.NODE_ENV === 'production' ? '/ha-component-kit/logo.png' : '/logo.png',
     brandTarget: '_self',
-    appBg: '#0e1118'
+    appBg: '#0e1118',
 });
 
-import { addons } from '@storybook/manager-api';
-
 addons.setConfig({
     panelPosition: 'right',
     showPanel: true,

.storybook/preview.tsx

@@ -1,10 +1,29 @@
 import type { Preview } from "@storybook/react";
 import { Title, Description, Primary, ArgTypes } from "@storybook/blocks";
 import React from "react";
+import { withThemeFromJSXProvider } from '@storybook/addon-themes';
+import { ThemeProvider } from '@storybook/theming';
 import './global.css';
 
+const THEME = {
+  typography: {
+    fonts: {
+      base: 'Arial, sans-serif',
+      mono: 'Courier, monospace'
+    }
+  }
+};
+
 export default {
   decorators: [
+    withThemeFromJSXProvider({
+      themes: {
+        dark: THEME,
+        light: THEME,
+      },
+      defaultTheme: 'dark',
+      Provider: ThemeProvider,
+    }),
     (Story, args) => {
       const centered = args.parameters.centered ? {
         width: '100%',
@@ -14,18 +33,20 @@ export default {
       } : {};
       if (window.parent) {
         const parentDocument = window.parent.document;
+        const logo = parentDocument.querySelector('.sidebar-header div img') as HTMLElement;
+        if (logo) {
+          logo.style.maxWidth = '100%';
+        }
         const panel = parentDocument.getElementById('storybook-panel-root');
         if (args.parameters?.addons?.showPanel === false && panel !== null && panel.parentElement !== null) {
           panel.parentElement.style.display = 'none';
-          if (panel.parentElement.parentElement?.previousElementSibling) {
-            // @ts-ignore - it's correct.
-            panel.parentElement.parentElement.previousElementSibling.style.width = '100%';
-            // @ts-ignore - it's correct.
-            panel.parentElement.parentElement.previousElementSibling.style.height = '100%';
-          }
         } else if (panel !== null && panel.parentElement !== null) {
           panel.parentElement.style.display = 'flex';
         }
+        const previewer = parentDocument.querySelector('#root div div:has(main)') as HTMLElement;
+        if (previewer !== null) {
+          previewer.style.height = '100dvh';
+        }
       }
       if (args.parameters.standalone) {
         return <Story />;
@@ -45,7 +66,6 @@ export default {
   ],
 
   parameters: {
-    actions: { argTypesRegex: "^on[A-Z].*" },
     layout: 'centered',
     controls: {
       matchers: {

ADDON.md

@@ -1,4 +1,4 @@
-# HAKIT Dashboard Addon
+# HAKIT Dashboard Addon (WIP)
 
 This addon simply serves your custom dashboard to a new sidebar link in home assistant making it easier to access your custom dashboard.
 

CHANGELOG.md

@@ -1,3 +1,49 @@
+# 3.1.5
+## @hakit/components
+- Previously all react props passed to the component were rendering as props on output elements, this wasn't visible with vite as it strips these out compile time, webpack however does not and some other bundlers don't either, now the cards will only render valid html props passed to components.
+- few issues with nextjs where window was used in the incorrect context, this has been fixed
+- Removed lazy import for the PersonControls popup as this is ignored as the popup uses static exports that are not dynamically exported
+- ThemeProvider - now accepts children which will allow you to pass props to the emotion CacheProvider if need be, this means you can perform tasks like telling hakit to change the container where styles are created by default if you're serving your dashboard within an iframe.
+- Now supports tree shaking - the library setup with the bundler is much more sophisticated now and will now bundle only the components you use in your application, this should reduce the size of the bundle significantly and should allow bundlers to perform caching mechanisms on the components.
+
+## @hakit/core
+- HassConnect - complete refactor to the authentication service, adding error logs and better error handling, simplified the token storage to remove the local cache which doesn't make sense why i included it to begin with! Should hopefully resolve issues raised: [issue 123](https://github.com/shannonhochkins/ha-component-kit/issues/123)
+- HassConnect now wrapped with memo from react - issues raised after testing with applications that render when HassConnect is NOT the root component, now should only re-render when props passed to HassConnect change.
+- Fixed some typescript problems with components returning JSX.Element instead of React.ReactNode
+- After the refactor of HassConnect the page no longer flickers with a secondary reload after authentication.
+- HassConnect will now allow you to change the hassUrl and ask you to re-login after it's changed, tokens are now stored by the hassUrl, previously if you changed your URL it would just fail to render and not ask you to login. Now when urls are different it'll ask you to login again.
+- Now supports tree shaking - the library setup with the bundler is much more sophisticated now and will now bundle only the components you use in your application, this should reduce the size of the bundle significantly and should allow bundlers to perform caching mechanisms on the components.
+
+## create-hakit v1.1.3
+- Fixed issue where node > 18 was causing the type sync and deploy script to fail: [issue 120](https://github.com/shannonhochkins/ha-component-kit/issues/120)
+- Added .nvmrc with the generated template to help indicate desired node version
+- Added default haUrl value
+- Better feedback / instructions in the terminal
+
+## Storybook
+- Fixed bug on FamilyCard where image wasn't rendering
+- Added "person" entity to storybook to test new popup
+- Added new demo for FamilyCard to show custom columns
+- Documented "EntitiesCardRow" in storybook
+- Upgraded storybook from 7 -> 8
+- Added new logo to storybook
+
+## General
+- New logo! Linked to the repo and storybook
+- Updated and tested most of the packages used within the repo that aren't peer dependencies
+- Created new Discord server! [Join here](https://discord.gg/agQr9JKk)
+- Updated the readme to include the new logo as well as links to the new discord server
+
+
+# 3.1.4
+## @hakit/components
+- NEW - FamilyCard - a card that allows multiple person entities to render in a single card, this will also allow the user to long press and show the location of the person. Huge thanks to @jensea for introducing this feature!
+- The same "location / map" functionality is also available when long pressing a row in the EntitiesCard if the entity entered is a "person" entity.
+- BUGFIX - types for GarbageCollectionCard subtypes were previously not exported, now exported under GarbageCollectionCardTypes
+- BUGFIX - automatic titles in modal have been fixed to convert to title case as well as allowing an override in the "modalProps" attribute for all cards.
+
+## @hakit/core
+- updating provider to allow global style overrides for new cards (FamilyCard, PersonCard)
 
 # 3.1.4
 ## @hakit/components

CODE_OF_CONDUCT.md

@@ -0,0 +1,123 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement via Discord.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
+version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder](https://opensource.creativecommons.org/community/code-of-conduct/enforcement/).
+
+For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are available at
+[https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).

CONTRIBUTING.md

@@ -5,7 +5,7 @@ If you want to contribute, fix bugs, integrate new features you can work with @h
 ```shell
 git clone https://github.com/shannonhochkins/ha-component-kit.git
 cd ha-component-kit
-npm install
+npm install && npm run build
 ```
 
 #### Local Storybook

README.md

@@ -1,15 +1,15 @@
 <table>
   <tr>
-    <td><img src="https://cdn.discordapp.com/icons/1231534799248691252/4b6124f952f099f855b5186d8a68f33e.webp?size=100" alt="LOGO"></td>
+    <td width="127"><img src="https://cdn.discordapp.com/icons/1231534799248691252/4b6124f952f099f855b5186d8a68f33e.webp?size=100" alt="LOGO" ></td>
     <td><h1>HA COMPONENT KIT</h1></td>
   </tr>
 </table>
 <p align="left">
   <a aria-label="@HAKIT/CORE" href="https://www.npmjs.com/package/@hakit/core">
-    <img alt="" src="https://img.shields.io/npm/v/@hakit/core.svg?style=for-the-badge&labelColor=000000">
+    <img alt="" src="https://img.shields.io/npm/v/@hakit/core.svg?style=for-the-badge&labelColor=000000&label=@hakit/CORE">
   </a>
   <a aria-label="@HAKIT/COMPONENTS" href="https://www.npmjs.com/package/@hakit/components">
-    <img alt="" src="https://img.shields.io/npm/v/@hakit/components.svg?style=for-the-badge&labelColor=000000">
+    <img alt="" src="https://img.shields.io/npm/v/@hakit/components.svg?style=for-the-badge&labelColor=000000&label=@HAKIT/COMPONENTS">
   </a>
   <a aria-label="Join the community on Discord" href="https://discord.gg/agQr9JKk">
     <img alt="" src="https://img.shields.io/badge/Join%20the%20Discord-blueviolet.svg?style=for-the-badge&logo=Discord&labelColor=000000&logoWidth=20">

hakit/.nvmrc

@@ -1 +1 @@
-18
+20

hakit/config.json

@@ -1,6 +1,6 @@
 {
   "name": "Hakit",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "slug": "hakit",
   "init": false,
   "ingress": true,