kuzzle-device-manager 0.4.8 → 0.4.9

package/lib/models/index.js

@@ -0,0 +1,16 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Device"), exports);
+__exportStar(require("./BaseAsset"), exports);
+__exportStar(require("./Catalog"), exports);
+//# sourceMappingURL=index.js.map

package/lib/types/AssetsHistoryContent.d.ts

@@ -0,0 +1,9 @@
+import { BaseAssetContent } from './BaseAssetContent';
+export interface AssetsHistoryContent {
+    assetId: string;
+    /**
+     * Names of measures historized in the document
+     */
+    measureTypes: string[];
+    asset: BaseAssetContent;
+}

package/lib/types/AssetsHistoryContent.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=AssetsHistoryContent.js.map

package/lib/types/BaseAssetContent.d.ts

@@ -0,0 +1,8 @@
+import { JSONObject } from "kuzzle";
+export interface BaseAssetContent {
+    type: string;
+    model: string;
+    reference: string;
+    measures?: JSONObject;
+    metadata?: JSONObject;
+}

package/lib/types/BaseAssetContent.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=BaseAssetContent.js.map

package/lib/types/DeviceContent.d.ts

@@ -0,0 +1,62 @@
+import { JSONObject } from 'kuzzle';
+import { DeviceMeasures } from './Measure';
+export declare type DeviceContent = {
+    /**
+     * Device unique reference for a model
+     */
+    reference: string;
+    /**
+     * Device measures gathered from a payload
+     */
+    measures?: DeviceMeasures;
+    /**
+     * Device model
+     * (This will be auto-filled by Kuzzle)
+     */
+    model?: string;
+    /**
+     * Device additionnal informations gathered from a payload
+     * (e.g. battery, network strength, etc.)
+     */
+    qos?: JSONObject;
+    /**
+     * Device metadata
+     */
+    metadata?: JSONObject;
+    /**
+     * Linked asset unique identifier
+     */
+    assetId?: string;
+    /**
+     * Attached tenant ID (index name)
+     */
+    tenantId?: string;
+    /**
+     * Document metadata
+     * @todo use DocumentMetadata when it's not an interface anymore
+     */
+    _kuzzle_info?: {
+        author?: string;
+        createdAt?: number;
+        updater?: string | null;
+        updatedAt?: number | null;
+    };
+};
+export declare type DeviceBulkContent = {
+    tenantId?: string;
+    deviceId: string;
+    assetId?: string;
+};
+export declare type DeviceBulkBuildedContent = {
+    tenantId: string;
+    deviceIds: string[];
+    assetIds: string[];
+};
+export declare type DeviceMAttachementContent = {
+    errors: JSONObject[];
+    successes: JSONObject[];
+};
+export declare type DeviceMRequestContent = {
+    _id: string;
+    body: JSONObject;
+};

package/lib/types/DeviceContent.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=DeviceContent.js.map

package/lib/types/Measure.d.ts

@@ -0,0 +1,54 @@
+import { JSONObject } from 'kuzzle';
+export interface BaseMeasure {
+    /**
+     * Date of the measure
+     */
+    updatedAt: number;
+    /**
+     * The payload uuid is auto-generated by Kuzzle
+     */
+    payloadUuid?: string;
+    [property: string]: any;
+}
+export interface PositionMeasure extends BaseMeasure {
+    point: {
+        lat: number;
+        lon: number;
+    };
+    altitude?: number;
+    accuracy?: number;
+}
+export interface TemperatureMeasure extends BaseMeasure {
+    degree: number;
+}
+export interface MovementMeasure extends BaseMeasure {
+    moving: boolean;
+}
+export declare type Measure = BaseMeasure;
+export declare type DeviceMeasures = {
+    position?: PositionMeasure;
+    temperature?: TemperatureMeasure;
+    movement?: MovementMeasure;
+    [measureType: string]: Measure;
+};
+export interface BaseAssetMeasure extends BaseMeasure {
+    /**
+     * Device ID
+     */
+    id: string;
+    /**
+     * Device model
+     */
+    model: string;
+    /**
+     * Device reference
+     */
+    reference: string;
+    /**
+     * Device metadata
+     */
+    metadata: JSONObject;
+}
+export declare type AssetMeasures = {
+    [measureType: string]: BaseAssetMeasure;
+};

package/lib/types/Measure.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Measure.js.map

package/lib/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from './Measure';
+export * from './DeviceContent';
+export * from './BaseAssetContent';

package/lib/types/index.js

@@ -0,0 +1,16 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Measure"), exports);
+__exportStar(require("./DeviceContent"), exports);
+__exportStar(require("./BaseAssetContent"), exports);
+//# sourceMappingURL=index.js.map

package/lib/utils/events.d.ts

@@ -0,0 +1,8 @@
+import { KuzzleRequest, JSONObject } from 'kuzzle';
+/**
+ * Returns a KuzzleRequest containing the payload in the result property.
+ *
+ * This is used to trigger event with payload that can be used by the workflow
+ * plugin.
+ */
+export declare function eventPayload(payload: JSONObject): KuzzleRequest;

package/lib/utils/events.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.eventPayload = void 0;
+const kuzzle_1 = require("kuzzle");
+/**
+ * Returns a KuzzleRequest containing the payload in the result property.
+ *
+ * This is used to trigger event with payload that can be used by the workflow
+ * plugin.
+ */
+function eventPayload(payload) {
+    return new kuzzle_1.KuzzleRequest({}, {
+        result: payload
+    });
+}
+exports.eventPayload = eventPayload;
+//# sourceMappingURL=events.js.map

package/lib/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './events';

package/lib/utils/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./events"), exports);
+//# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kuzzle-device-manager",
-  "version": "0.4.8",
+  "version": "0.4.9",
   "description": "Manage your IoT devices and assets. Choose a provisionning strategy, receive and decode payload, handle your IoT business logic.",
   "author": "The Kuzzle Team (support@kuzzle.io)",
   "repository": {