@digital-alchemy/hass 0.3.2 → 0.3.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +25 -0
  2. package/package.json +7 -7
package/README.md CHANGED
@@ -3,6 +3,7 @@
3
3
  This repository contains generic extensions for interacting with Home Assistant, including websocket & REST API adapters, entity & event management, backup workflows, and more.
4
4
 
5
5
  > See more at the [extended docs](https://docs.digital-alchemy.app/02-Home-Automation/02.01-hass/%F0%9F%A7%AD-Hass-Overview)
6
+ > Ask questions on [Discord](https://discord.digital-alchemy.app)
6
7
 
7
8
  ## ⭐ Features
8
9
  ### 📝 First-class Editor Experiences
@@ -18,6 +19,30 @@ Create references to entities that will always reflect their current state. Get
18
19
 
19
20
  Don't worry about all the complexities of dealing with Home Assistant. Let the library help by handling all the connection logic, keeping track of events for you, formatting requests, and more.
20
21
 
22
+ ## Install
23
+
24
+ Add as a dependency, and add to your imports. Nice and easy
25
+
26
+ ```bash
27
+ npm i @digital-alchemy/hass
28
+ ```
29
+
30
+ ```typescript
31
+ import { LIB_HASS } from "@digital-alchemy/hass";
32
+
33
+ // application
34
+ const MY_APP = CreateApplication({
35
+ libraries: [LIB_HASS],
36
+ name: "home_automation",
37
+ })
38
+
39
+ // library
40
+ export const MY_LIBRARY = CreateLibrary({
41
+ depends: [LIB_HASS],
42
+ name: "special_logic",
43
+ })
44
+ ```
45
+
21
46
  ## ⚙️ Configuration
22
47
  ### 🛠 Custom Types
23
48
 
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@digital-alchemy/hass",
3
3
  "repository": "https://github.com/Digital-Alchemy-TS/hass",
4
4
  "homepage": "https://docs.digital-alchemy.app/02-Home-Automation/02.01-hass/%F0%9F%A7%AD-Hass-Overview",
5
- "version": "0.3.2",
5
+ "version": "0.3.3",
6
6
  "scripts": {
7
7
  "build": "rm -rf dist/; tsc",
8
8
  "lint": "eslint src",
@@ -24,7 +24,7 @@
24
24
  },
25
25
  "license": "MIT",
26
26
  "dependencies": {
27
- "@digital-alchemy/core": "^0.3.2",
27
+ "@digital-alchemy/core": "^0.3.5",
28
28
  "dayjs": "^1.11.10",
29
29
  "prom-client": "^15.1.0",
30
30
  "ws": "^8.16.0"
@@ -36,15 +36,15 @@
36
36
  "@types/js-yaml": "^4.0.9",
37
37
  "@types/minimist": "^1.2.5",
38
38
  "@types/mute-stream": "^0.0.4",
39
- "@types/node": "^20.11.28",
39
+ "@types/node": "^20.11.30",
40
40
  "@types/uuid": "^9.0.8",
41
41
  "@types/ws": "^8.5.10",
42
- "@typescript-eslint/eslint-plugin": "7.2.0",
43
- "@typescript-eslint/parser": "7.2.0",
42
+ "@typescript-eslint/eslint-plugin": "7.3.1",
43
+ "@typescript-eslint/parser": "7.3.1",
44
44
  "eslint": "8.57.0",
45
45
  "eslint-config-prettier": "9.1.0",
46
46
  "eslint-plugin-import": "^2.29.1",
47
- "eslint-plugin-jsonc": "^2.13.0",
47
+ "eslint-plugin-jsonc": "^2.14.1",
48
48
  "eslint-plugin-no-unsanitized": "^4.0.2",
49
49
  "eslint-plugin-prettier": "^5.1.3",
50
50
  "eslint-plugin-security": "^2.1.1",
@@ -58,7 +58,7 @@
58
58
  "prettier": "^3.2.5",
59
59
  "ts-jest": "^29.1.2",
60
60
  "tsx": "^4.7.1",
61
- "type-fest": "^4.12.0",
61
+ "type-fest": "^4.13.0",
62
62
  "typescript": "^5.4.2"
63
63
  }
64
64
  }