home-assistant-js-websocket - npm Package Compare versions

Comparing version 6.1.1 to 7.0.0

dist/collection.d.ts

@@ -9,3 +9,11 @@ import { Store } from "./store.js";
 };
-export declare const getCollection: <State>(conn: Connection, key: string, fetchCollection: (conn: Connection) => Promise<State>, subscribeUpdates?: ((conn: Connection, store: Store<State>) => Promise<UnsubscribeFunc>) | undefined) => Collection<State>;
+/**
+ *
+ * @param conn connection
+ * @param key the key to store it on the connection. Must be unique for each collection.
+ * @param fetchCollection fetch the current state. If undefined assumes subscribeUpdates receives current state
+ * @param subscribeUpdates subscribe to updates on the current state
+ * @returns
+ */
+export declare const getCollection: <State>(conn: Connection, key: string, fetchCollection: ((conn: Connection) => Promise<State>) | undefined, subscribeUpdates?: ((conn: Connection, store: Store<State>) => Promise<UnsubscribeFunc>) | undefined) => Collection<State>;
 export declare const createCollection: <State>(key: string, fetchCollection: (conn: Connection) => Promise<State>, subscribeUpdates: ((conn: Connection, store: Store<State>) => Promise<UnsubscribeFunc>) | undefined, conn: Connection, onChange: (state: State) => void) => UnsubscribeFunc;

dist/collection.js

 import { createStore } from "./store.js";
+/**
+ *
+ * @param conn connection
+ * @param key the key to store it on the connection. Must be unique for each collection.
+ * @param fetchCollection fetch the current state. If undefined assumes subscribeUpdates receives current state
+ * @param subscribeUpdates subscribe to updates on the current state
+ * @returns
+ */
 export const getCollection = (conn, key, fetchCollection, subscribeUpdates) => {
@@ -9,3 +17,8 @@ if (conn[key]) {
     let store = createStore();
-    const refresh = () => fetchCollection(conn).then((state) => store.setState(state, true));
+    const refresh = () => {
+        if (!fetchCollection) {
+            throw new Error("Collection does not support refresh");
+        }
+        return fetchCollection(conn).then((state) => store.setState(state, true));
+    };
     const refreshSwallow = () => refresh().catch((err) => {
@@ -32,3 +45,5 @@ // Swallow errors if socket is connecting, closing or closed.
                 conn.addEventListener("ready", refreshSwallow);
-                refreshSwallow();
+                if (fetchCollection) {
+                    refreshSwallow();
+                }
             }
@@ -35,0 +50,0 @@ const unsub = store.subscribe(subscriber);

dist/entities.d.ts

 import { HassEntities, UnsubscribeFunc } from "./types.js";
 import { Connection } from "./connection.js";
-export declare const entitiesColl: (conn: Connection) => import("./collection.js").Collection<{}>;
+export declare const entitiesColl: (conn: Connection) => import("./collection.js").Collection<HassEntities>;
 export declare const subscribeEntities: (conn: Connection, onChange: (state: HassEntities) => void) => UnsubscribeFunc;

dist/entities.js

@@ -104,4 +104,4 @@ import { getCollection } from "./collection.js";
 export const entitiesColl = (conn) => atLeastHaVersion(conn.haVersion, 2022, 4, 0)
-    ? getCollection(conn, "_ent", () => Promise.resolve({}), subscribeUpdates)
+    ? getCollection(conn, "_ent", undefined, subscribeUpdates)
     : getCollection(conn, "_ent", legacyFetchEntities, legacySubscribeUpdates);
 export const subscribeEntities = (conn, onChange) => entitiesColl(conn).subscribe(onChange);

dist/haws.umd.js

@@ -781,2 +781,10 @@ (function (global, factory) {
 
+    /**
+     *
+     * @param conn connection
+     * @param key the key to store it on the connection. Must be unique for each collection.
+     * @param fetchCollection fetch the current state. If undefined assumes subscribeUpdates receives current state
+     * @param subscribeUpdates subscribe to updates on the current state
+     * @returns
+     */
     const getCollection = (conn, key, fetchCollection, subscribeUpdates) => {
@@ -789,3 +797,8 @@ if (conn[key]) {
         let store = createStore();
-        const refresh = () => fetchCollection(conn).then((state) => store.setState(state, true));
+        const refresh = () => {
+            if (!fetchCollection) {
+                throw new Error("Collection does not support refresh");
+            }
+            return fetchCollection(conn).then((state) => store.setState(state, true));
+        };
         const refreshSwallow = () => refresh().catch((err) => {
@@ -812,3 +825,5 @@ // Swallow errors if socket is connecting, closing or closed.
                     conn.addEventListener("ready", refreshSwallow);
-                    refreshSwallow();
+                    if (fetchCollection) {
+                        refreshSwallow();
+                    }
                 }
@@ -1001,3 +1016,3 @@ const unsub = store.subscribe(subscriber);
     const entitiesColl = (conn) => atLeastHaVersion(conn.haVersion, 2022, 4, 0)
-        ? getCollection(conn, "_ent", () => Promise.resolve({}), subscribeUpdates)
+        ? getCollection(conn, "_ent", undefined, subscribeUpdates)
         : getCollection(conn, "_ent", legacyFetchEntities, legacySubscribeUpdates);
@@ -1004,0 +1019,0 @@ const subscribeEntities = (conn, onChange) => entitiesColl(conn).subscribe(onChange);

package.json

@@ -5,3 +5,3 @@ {
   "sideEffects": false,
-  "version": "6.1.1",
+  "version": "7.0.0",
   "description": "Home Assistant websocket client",
@@ -8,0 +8,0 @@ "source": "lib/index.ts",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

168871

increased by1.14%

Lines of code

3517

increased by1.53%

No dependency changes