Rename

src/@arduino/cbor-js.d.ts

@@ -25,10 +25,10 @@
 
 
 declare module '@arduino/cbor-js' {
-  export function encode(value: CBORValue[], numericKeys?: boolean): ArrayBuffer;
-  export function decode(data: ArrayBuffer, tagger?: (value: CBORValue) => CBORValue, simpleValue?: CBORValue): CBORValue[];
+  export function encode(value: SenML[], numericKeys?: boolean): ArrayBuffer;
+  export function decode(data: ArrayBuffer, tagger?: (value: SenML) => SenML, simpleValue?: SenML): SenML[];
 
-  export type CBORValue = {
+  export type SenML = {
     bn?: string;
     bt?: number;
     bu?: string;

src/client/ArduinoCloudClient.ts

@@ -1,7 +1,7 @@
 import { filter } from "rxjs/operators";
 import { Subscription, Subject, Observable } from "rxjs";
 
-import CBOR from "../cbor";
+import SenML from "../senML";
 import Utils from "../utils";
 import { IConnectionBuilder } from '../builder/IConnectionBuilder';
 import { IConnection, CloudMessage } from "../connection/IConnection";
@@ -161,8 +161,8 @@ export class ArduinoCloudClient implements IArduinoCloudClient {
 
   public async sendProperty<T extends CloudMessageValue>(thingId: string, name: string, value: T, timestamp: number = new Date().getTime()): Promise<void> {
     const topic = `/a/t/${thingId}/e/i`;
-    const values = CBOR.getSenML(name, value, timestamp, this.options.useCloudProtocolV2, null);
-    return this.sendMessage(topic, CBOR.encode(Utils.isArray(values) ? values : [values], true));
+    const values = SenML.parse(name, value, timestamp, this.options.useCloudProtocolV2, null);
+    return this.sendMessage(topic, SenML.CBOR.encode(Utils.isArray(values) ? values : [values], true));
   }
 
   public async onPropertyValue<T extends CloudMessageValue>(thingId: string, name: string, cb: OnMessageCallback<T>): Promise<void> {

src/connection/Connection.ts

@@ -2,7 +2,7 @@ import jws from 'jws';
 import mqtt from 'mqtt';
 import { Observable, Subject } from "rxjs";
 
-import CBOR from '../cbor';
+import SenML from '../senML';
 import Utils from "../utils";
 import { CloudMessageValue } from "../client/IArduinoCloudClient";
 import { IConnection, CloudMessage, ConnectionOptions } from "./IConnection";
@@ -84,11 +84,11 @@ export class Connection implements IConnection {
     let valueToSend: CloudMessageValue = {};
 
     const messages: CloudMessage[] = [];
-    const properties = CBOR.decode(Utils.toArrayBuffer(msg));
+    const properties = SenML.CBOR.decode(Utils.toArrayBuffer(msg));
 
     properties.forEach((p) => {
-      const value = CBOR.valueFrom(p);
-      [current, attribute] = CBOR.nameFrom(p).split(':');
+      const value = SenML.valueFrom(p);
+      [current, attribute] = SenML.nameFrom(p).split(':');
       if (previous === '') previous = current;
 
       if (previous !== current) {

src/index.lib.ts

@@ -18,7 +18,7 @@
 *
 */
 
-import CBOR from './cbor';
+import SenML from './senML';
 import fetch from "node-fetch";
 import { HttpClientFactory } from './http/HttpClientFactory';
 import { ArduinoCloudClient } from "./client/ArduinoCloudClient";
@@ -28,5 +28,6 @@ import { TokenConnectionBuilder } from "./builder/TokenConnectionBuilder";
 const builders = [new TokenConnectionBuilder(), new APIConnectionBuilder(HttpClientFactory.Create(fetch))];
 const DefaultClient = new ArduinoCloudClient(builders);
 
-export { CBOR };
 export default DefaultClient;
+export { SenML, ArduinoCloudClient };
+export { IArduinoCloudClient, CloudOptions, CloudMessageValue } from "./client/IArduinoCloudClient";

src/index.ts

@@ -19,7 +19,7 @@
 */
 
 import "whatwg-fetch";
-import CBOR from './cbor';
+import SenML from './senML';
 import { HttpClientFactory } from './http/HttpClientFactory';
 import { ArduinoCloudClient } from "./client/ArduinoCloudClient";
 import { APIConnectionBuilder } from "./builder/APIConnectionBuilder";
@@ -28,5 +28,6 @@ import { TokenConnectionBuilder } from "./builder/TokenConnectionBuilder";
 const builders = [new TokenConnectionBuilder(), new APIConnectionBuilder(HttpClientFactory.Create(fetch))];
 const DefaultClient = new ArduinoCloudClient(builders);
 
-export { CBOR };
 export default DefaultClient;
+export { SenML, ArduinoCloudClient };
+export { IArduinoCloudClient, CloudOptions, CloudMessageValue } from "./client/IArduinoCloudClient";

src/cbor/index.ts → src/senML/index.ts

@@ -1,28 +1,28 @@
-import { encode, decode, CBORValue } from '@arduino/cbor-js';
+import CBOR, { SenML } from '@arduino/cbor-js';
 
 import Utils from "../utils";
 import { CloudMessageValue } from "../client/IArduinoCloudClient";
 
-function isPropertyValue(message: CBORValue | string[]): message is CBORValue {
-  return !!(message as CBORValue).n;
+function isPropertyValue(message: SenML | string[]): message is SenML {
+  return !!(message as SenML).n;
 }
 
-function valueFrom(message: CBORValue | string[]): CloudMessageValue {
+function valueFrom(message: SenML | string[]): CloudMessageValue {
   return isPropertyValue(message)
     ? message.v || message.vs || message.vb
     : message[2] || message[3] || message[4];
 }
 
-function nameFrom(property: CBORValue | string[]): string {
+function nameFrom(property: SenML | string[]): string {
   return isPropertyValue(property) ? property.n : property[0]
 }
 
-function toString(value: CBORValue[]): string {
-  const encoded = encode(value);
+function toString(value: SenML[]): string {
+  const encoded = CBOR.encode(value);
   return Utils.arrayBufferToBase64(encoded);
 };
 
-function toCloudProtocolV2(cborValue: CBORValue): CBORValue {
+function toCloudProtocolV2(cborValue: SenML): SenML {
   const cloudV2CBORValue = {};
   let cborLabel = null;
 
@@ -52,8 +52,8 @@ function toCloudProtocolV2(cborValue: CBORValue): CBORValue {
   return cloudV2CBORValue;
 }
 
-function parse(value: CloudMessageValue, name: string, timestamp: number, deviceId: string): CBORValue {
-  const parsed: CBORValue = {};
+function format(value: CloudMessageValue, name: string, timestamp: number, deviceId: string): SenML {
+  const parsed: SenML = {};
   if (timestamp !== -1) parsed.bt = timestamp || new Date().getTime()
   parsed.n = name;
 
@@ -68,24 +68,23 @@ function parse(value: CloudMessageValue, name: string, timestamp: number, device
   return parsed;
 }
 
-function getSenML(name: string, value: CloudMessageValue, timestamp: number, useCloudProtocolV2: boolean, deviceId: string): CBORValue | CBORValue[] {
+function parse(name: string, value: CloudMessageValue, timestamp: number, useCloudProtocolV2: boolean, deviceId: string): SenML | SenML[] {
   if (timestamp && !Number.isInteger(timestamp)) throw new Error('Timestamp must be Integer');
   if (name === undefined || typeof name !== 'string') throw new Error('Name must be a valid string');
 
   if (Utils.isObject(value)) return Object.keys(value)
-    .map((key, i) => parse(value[key], `${name}:${key}`, i === 0 ? timestamp : -1, i === 0 ? deviceId : undefined))
+    .map((key, i) => format(value[key], `${name}:${key}`, i === 0 ? timestamp : -1, i === 0 ? deviceId : undefined))
     .map((cborValue) => useCloudProtocolV2 ? toCloudProtocolV2(cborValue) : cborValue);
 
-  let cborValue = parse(value, name, timestamp, deviceId);
+  let cborValue = format(value, name, timestamp, deviceId);
   if (useCloudProtocolV2) cborValue = toCloudProtocolV2(cborValue);
   return cborValue;
 };
 
 export default {
-  encode,
-  decode,
+  CBOR,
+  parse,
   toString,
-  getSenML,
   valueFrom,
   nameFrom,
   isPropertyValue,

test/arduino-cloud.test.js

@@ -17,8 +17,8 @@
 * a commercial license, send an email to license@arduino.cc.
 *
 */
-const ArduinoCloud = require('../dist/index.js').default;
-const { CBOR } = require('../dist/index.js');
+const ArduinoCloud = require('../dist/index.js');
+const { SenML } = require('../dist/index.js');
 
 const deviceId = '1f4ced70-53ad-4b29-b221-1b0abbdfc757';
 const thingId = '2cea8542-d472-4464-859c-4ef4dfc7d1d3';
@@ -106,6 +106,6 @@ const sendPropertyAsDevice = (deviceId, thingId, name, value, timestamp = new Da
   if (timestamp && !Number.isInteger(timestamp)) throw new Error('Timestamp must be Integer');
   if (name === undefined || typeof name !== 'string') throw new Error('Name must be a valid string');
 
-  const senMlValue = CBOR.getSenML(name, value, timestamp, false, deviceId);
-  return ArduinoCloud.sendMessage(`/a/t/${thingId}/e/o`, CBOR.encode([senMlValue]));
+  const senMlValue = SenML.parse(name, value, timestamp, false, deviceId);
+  return ArduinoCloud.sendMessage(`/a/t/${thingId}/e/o`, SenML.CBOR.encode([senMlValue]));
 };