Merge branch 'dev'

Author: ivan-gerasimov-1

CHANGELOG.md

@@ -0,0 +1,14 @@
+## 0.1.0-alpha.1 (2020-10-09)
+
+### New Features & Enhancements
+
+- feat(IDevice) Add "status" and "tags" field
+- feat(IApp) Add "status" field
+- feat(entities) Add "EntityStatus" enum
+- feat(entities) Add "ConnectionStatus" enum
+- feat(RestClient) Allow "number" values in IQueryParams
+- feat(\*) Export "IDisposable" interface
+
+### Breaking Changes
+
+- feat(RestClient) Remove "undefined" values from queryParams

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@connio/js-sdk",
-  "version": "0.1.0-alpha.0",
+  "version": "0.1.0-alpha.1",
   "description": "Connio JavaScript SDK",
   "main": "./src/index.ts",
   "repository": {

package.json

@@ -1,6 +1,8 @@
 import { IBaseEntity } from '../entities/base';
+import { EntityStatus } from './entity-status';
 
 export interface IApp extends IBaseEntity {
   friendlyName?: string;
   description?: string;
+  status: EntityStatus;
 }

src/entities/app.ts

@@ -0,0 +1,4 @@
+export enum ConnectionStatus {
+  Offline = 'offline',
+  Online = 'online',
+}

src/entities/connection-status.ts

@@ -1,7 +1,10 @@
 import { IBaseEntity } from '../entities/base';
+import { EntityStatus } from './entity-status';
 
 export interface IDevice extends IBaseEntity {
   friendlyName?: string;
   description?: string;
   apps?: string[];
+  status: EntityStatus;
+  tags?: string[];
 }

src/entities/device.ts

@@ -0,0 +1,5 @@
+export enum EntityStatus {
+  Debug = 'debug',
+  Disabled = 'disabled',
+  Enabled = 'enabled',
+}

src/entities/entity-status.ts

@@ -10,8 +10,10 @@ export { IApiKey } from './api-key';
 export { IApp } from './app';
 export { IAppProfile } from './app-profile';
 export { IAuthData } from './auth-data';
+export { ConnectionStatus } from './connection-status';
 export { ICredentials } from './credentials';
 export { IDevice } from './device';
+export { EntityStatus } from './entity-status';
 export { EntityType } from './entity-type';
 export { IEnvConfig } from './env-config';
 export { IBoundaries as IPropertyBoundaries, IProperty } from './property';

src/entities/index.ts

@@ -4,4 +4,5 @@ export { Apps, IApps } from './apps';
 export { Auth, IAuth } from './auth';
 export { ICredentialsStore } from './credentials';
 export { Devices, IDevices } from './devices';
+export { IDisposable } from './disposable';
 export { RestClient } from './rest-client';

src/index.ts

@@ -40,5 +40,5 @@ export interface IDeleteResponse {
 }
 
 export interface IQueryParams {
-  [key: string]: string | number;
+  [key: string]: string;
 }

src/rest-client/definitions.ts

@@ -10,6 +10,14 @@ import {
   RequestMethod,
 } from './definitions';
 
+/**
+ * @todo
+ * - Move to utils
+ */
+export function identity<T = any>(value: T) {
+  return value;
+}
+
 export interface IRestClient {
   get<T>(url: string, queryParams?: IQueryParams): Promise<T>;
   post<T>(url: string, payload: TPostRequestPayload): Promise<T>;
@@ -80,9 +88,15 @@ export class RestClient implements IRestClient {
     let queryString = '';
 
     if (queryParams) {
-      let queryParamList = Object.entries(queryParams).map(([key, value]) => {
-        return `${key}=${value}`;
-      });
+      let queryParamList = Object.entries(queryParams)
+        .map(([key, value]) => {
+          if (value === undefined) {
+            return undefined;
+          }
+
+          return `${key}=${value}`;
+        })
+        .filter(identity);
 
       queryString = `?${queryParamList.join('&')}`;
     }