homey-api 3.0.13 → 3.0.15

package/assets/types/homey-api.private.d.ts

@@ -4451,8 +4451,6 @@ export class Util {
 
   static getSearchParameter(name: string): string | null;
 
-  static stringifyQuery(object: object): string;
-
   static base64(input: string): string;
 
   static uuid(): string;
@@ -4461,6 +4459,8 @@ export class Util {
 
   static promiseAny(promises: Array<Promise>): Promise<any>;
 
+  static serializeQueryObject(queryObject: object): string;
+
   static fetch(args: any): Promise;
 
   static wait(ms: number): Promise<void>;
@@ -4485,8 +4485,6 @@ export class Util {
 
   static getSearchParameter(name: string): string | null;
 
-  static stringifyQuery(object: object): string;
-
   static base64(input: string): string;
 
   static uuid(): string;
@@ -4494,6 +4492,8 @@ export class Util {
   static env(): string;
 
   static promiseAny(promises: Array<Promise>): Promise<any>;
+
+  static serializeQueryObject(queryObject: object): string;
 }
 
 export class APIDefinition {}
@@ -7407,8 +7407,6 @@ export class Util {
 
   static getSearchParameter(name: string): string | null;
 
-  static stringifyQuery(object: object): string;
-
   static base64(input: string): string;
 
   static uuid(): string;
@@ -7417,6 +7415,8 @@ export class Util {
 
   static promiseAny(promises: Array<Promise>): Promise<any>;
 
+  static serializeQueryObject(queryObject: object): string;
+
   static fetch(args: any): Promise;
 
   static wait(ms: number): Promise<void>;
@@ -7441,8 +7441,6 @@ export class Util {
 
   static getSearchParameter(name: string): string | null;
 
-  static stringifyQuery(object: object): string;
-
   static base64(input: string): string;
 
   static uuid(): string;
@@ -7450,6 +7448,8 @@ export class Util {
   static env(): string;
 
   static promiseAny(promises: Array<Promise>): Promise<any>;
+
+  static serializeQueryObject(queryObject: object): string;
 }
 
 export namespace HomeyAPIV3Cloud {

package/lib/API.js

@@ -97,7 +97,7 @@ class API {
           }
 
           if (typeof value !== 'undefined') {
-            if (parameter.type === 'string' && typeof value !== 'string') {
+            if (parameter.in !== 'query' && parameter.type === 'string' && typeof value !== 'string') {
               throw new Error(`Invalid Parameter Type: ${parameterId}. Got: ${typeof value}. Expected: string`);
             }
 
@@ -201,7 +201,7 @@ class API {
 
     if (request.query) {
       if (Object.keys(request.query).length) {
-        request.url += `?${Util.stringifyQuery(request.query)}`;
+        request.url += `?${Util.serializeQueryObject(request.query)}`;
       }
     }
 
@@ -280,7 +280,8 @@ class API {
 
     if (responseContentType && responseContentType.toLowerCase().includes('application/json')) {
       try {
-        return JSON.parse(responseText);
+        const parsed = JSON.parse(responseText);
+        return parsed;
       } catch (err) {
         throw new Error(`Failed to parse response body as JSON: ${err.message}`);
       }
@@ -298,6 +299,21 @@ class API {
     // eslint-disable-next-line no-unused-vars
     statusText,
   }) {
+    if (typeof body !== 'object' || body === null) {
+      return body;
+    }
+
+    // For ?
+    if (body.status != null && body.result != null) {
+      return body.result;
+    }
+
+    // For setup API. https://github.com/athombv/athom-cloud-setup/blob/e7764021d33415f21a1e27ce6a874aa41dc7cfdc/lib/Server/index.js#L30
+    if (body.success != null && body.message != null) {
+      return body.message;
+    }
+
+
     return body;
   }
 
@@ -319,7 +335,10 @@ class API {
     } else if (typeof body.error === 'string') {
       message = body.error;
     } else if (typeof body.message === 'string') {
+      // Setup API returns message.
       message = body.message;
+    } else if (typeof body.result === 'string') {
+      message = body.result;
     }
 
     throw new APIError(message, statusCode);

package/lib/HomeyAPI/HomeyAPIV3/Manager.js

@@ -189,19 +189,22 @@ class Manager extends EventEmitter {
               path = `${path}?${queryString}`;
             }
 
+            const pendingCallId = `${operationId}::${path}`
+
             if (
               operation.method.toLowerCase() === 'get' &&
               $cache === true &&
-              this.__pendingCalls[path] != null &&
+              this.__pendingCalls[pendingCallId] != null &&
               Object.keys(body).length === 0
             ) {
-              this.__debug(`Reusing pending call ${operationId}`);
-              const result = await this.__pendingCalls[path];
+              this.__debug(`Reusing pending call ${pendingCallId}`);
+
+              const result = await this.__pendingCalls[pendingCallId];
 
               return result;
             }
 
-            this.__pendingCalls[path] = (async () => {
+            const pendingCall = (async () => {
               const result = await this.__request({
                 $validate,
                 $cache,
@@ -217,11 +220,21 @@ class Manager extends EventEmitter {
               });
 
               return result;
-            })().finally(() => {
-              delete this.__pendingCalls[path];
-            });
+            })();
+
+            if (
+              operation.method.toLowerCase() === 'get' &&
+              $cache === true &&
+              this.__pendingCalls[pendingCallId] == null &&
+              Object.keys(body).length === 0
+            ) {
+              this.__pendingCalls[pendingCallId] = pendingCall;
+              this.__pendingCalls[pendingCallId].finally(() => {
+                delete this.__pendingCalls[pendingCallId];
+              });
+            }
 
-            const result = await this.__pendingCalls[path];
+            const result = await pendingCall;
 
             return result;
           },

package/lib/HomeyAPI/HomeyAPIV3/ManagerFlowToken/FlowToken.js

@@ -25,11 +25,6 @@ class FlowToken extends Item {
     return item;
   }
 
-  get uri() {
-    console.warn('FlowToken.uri is deprecated. Use FlowToken.ownerUri instead.');
-    return undefined;
-  }
-
   get uriObj() {
     console.warn('FlowToken.uriObj is deprecated.');
     return undefined;

package/lib/Util.js

@@ -123,19 +123,6 @@ class Util {
     return searchParams.get(name) || null;
   }
 
-  /**
-   * Converts an object to a query string
-   * @param {object} object - Query parameter object
-   * @returns {string}
-   */
-  static stringifyQuery(obj) {
-    const searchParams = new URLSearchParams();
-    for (const [key, value] of Object.entries(obj)) {
-      searchParams.append(key, value);
-    }
-    return searchParams.toString();
-  }
-
   /**
    * This method encodes a string into a base64 string.
    * It's provided as Util because Node.js uses `Buffer`,
@@ -256,6 +243,11 @@ class Util {
     });
   }
 
+    /**
+   * Converts an object to a query string
+   * @param {object} queryObject - Query parameter object
+   * @returns {string}
+   */
   static serializeQueryObject(queryObject) {
     let prefix;
     let querystring = [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homey-api",
-  "version": "3.0.13",
+  "version": "3.0.15",
   "description": "Homey API",
   "main": "index.js",
   "files": [