kuzzle-device-manager 0.4.13 → 2.0.0-rc3

package/lib/core-classes/BatchProcessing/BatchWriter.js

@@ -1,264 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BatchWriter = exports.BatchBuffer = void 0;
-const BatchController_1 = require("./BatchController");
-const InstrumentablePromise_1 = require("./InstrumentablePromise");
-class BatchBuffer {
-    constructor() {
-        this.indexes = {};
-    }
-    /**
-     * Add a document to the buffer of a specific collection
-     *
-     * @param index Index name
-     * @param collection Collection name
-     * @param body Document content
-     * @param _id Document ID
-     * @param options Option object passed to the m* action
-     *
-     * @returns An object containing the index of the array of results and a promise resolving to the array of results
-     */
-    add(index, collection, body, _id = undefined, options) {
-        if (!this.indexes[index]) {
-            this.indexes[index] = {};
-        }
-        if (!this.indexes[index][collection]) {
-            this.indexes[index][collection] = {
-                documents: [],
-                promise: new InstrumentablePromise_1.InstrumentablePromise(),
-                options,
-            };
-        }
-        const idx = this.indexes[index][collection].documents.length;
-        this.indexes[index][collection].options = { ...this.indexes[index][collection].options, ...options };
-        this.indexes[index][collection].documents.push({
-            _id,
-            body
-        });
-        return {
-            idx,
-            promise: this.indexes[index][collection].promise,
-        };
-    }
-}
-exports.BatchBuffer = BatchBuffer;
-/**
- * This class handle buffers for every supported API action of the document controller:
- *  - create, update, createOrReplace, replace, get, exists, delete
- *
- * Each buffer is filled with documents to be write/get/delete into a collection.
- *
- * A timer will regularly execute the m* actions with the documents inside the buffers.
- *
- * If the interval is too big, buffers may contain too much documents for Kuzzle limits.
- * (e.g. "limits.documentsWriteCount" is 200 by default)
- */
-class BatchWriter {
-    /**
-     * @param sdk Connected SDK
-     * @param options.interval Timer interval in ms (50). Actions will be executed every {interval} ms
-     * @param options.maxWriteBufferSize Max write buffer size (200). (Should match "limits.documentsWriteCount")
-     * @param options.maxReadBufferSize Max read buffer size. (Should match "limits.documentsReadCount")
-     */
-    constructor(sdk, { interval = 50, maxWriteBufferSize = 200, maxReadBufferSize = 200 } = {}) {
-        // Buffers
-        this.buffers = {
-            create: new BatchBuffer(),
-            update: new BatchBuffer(),
-            get: new BatchBuffer(),
-            exists: new BatchBuffer(),
-            delete: new BatchBuffer(),
-            replace: new BatchBuffer(),
-            createOrReplace: new BatchBuffer(),
-        };
-        this.sdk = sdk;
-        this.interval = interval;
-        this.maxWriteBufferSize = maxWriteBufferSize;
-        this.maxReadBufferSize = maxReadBufferSize;
-        this.document = new BatchController_1.BatchController(this.sdk, this);
-    }
-    get addCreate() {
-        // @todo implements the send of buffer if approaching the limit
-        return this.buffers.create.add.bind(this.buffers.create);
-    }
-    get addUpdate() {
-        return this.buffers.update.add.bind(this.buffers.update);
-    }
-    get addGet() {
-        return this.buffers.get.add.bind(this.buffers.get);
-    }
-    get addExists() {
-        return this.buffers.exists.add.bind(this.buffers.exists);
-    }
-    get addDelete() {
-        return this.buffers.delete.add.bind(this.buffers.delete);
-    }
-    get addReplace() {
-        return this.buffers.replace.add.bind(this.buffers.replace);
-    }
-    get addCreateOrReplace() {
-        return this.buffers.createOrReplace.add.bind(this.buffers.createOrReplace);
-    }
-    /**
-     * Execute API actions with documents stored in the buffers.
-     */
-    async execute() {
-        const buffers = {};
-        // make a copy of the buffers
-        for (const [name, buffer] of Object.entries(this.buffers)) {
-            buffers[name] = buffer;
-        }
-        // prepare to enqueue documents in buffers
-        this.prepareRound();
-        await Promise.all([
-            this.sendCreateBuffer(buffers.create),
-            this.sendUpdateBuffer(buffers.update),
-            this.sendCreateOrReplaceBuffer(buffers.createOrReplace),
-            this.sendDeleteBuffer(buffers.delete),
-            this.sendExistsBuffer(buffers.exists),
-            this.sendGetBuffer(buffers.get),
-            this.sendReplaceBuffer(buffers.replace),
-        ]);
-    }
-    /**
-     * Initialize the buffers and start the timer
-     */
-    begin() {
-        this.prepareRound();
-        this.timer = setInterval(async () => {
-            await this.execute();
-        }, this.interval);
-    }
-    /**
-     * Execute pending actions from the buffers and stop the timer.
-     */
-    async end() {
-        await this.execute();
-        clearInterval(this.timer);
-    }
-    /**
-     * Reset all the buffers
-     */
-    prepareRound() {
-        for (const name of Object.keys(this.buffers)) {
-            this.buffers[name] = new BatchBuffer();
-        }
-    }
-    async sendCreateBuffer(buffer, options) {
-        const promises = [];
-        for (const [index, collectionBuffer] of Object.entries(buffer.indexes)) {
-            for (const [collection, { promise, documents }] of Object.entries(collectionBuffer)) {
-                if (documents.length === 0) {
-                    promise.resolve();
-                    continue;
-                }
-                promises.push(this.sdk.document.mCreate(index, collection, documents, { ...options, strict: true })
-                    .then(promise.resolve)
-                    .catch(promise.reject));
-            }
-        }
-        await Promise.all(promises);
-    }
-    async sendUpdateBuffer(buffer, options) {
-        const promises = [];
-        for (const [index, collectionBuffer] of Object.entries(buffer.indexes)) {
-            for (const [collection, { promise, documents }] of Object.entries(collectionBuffer)) {
-                if (documents.length === 0) {
-                    promise.resolve();
-                    continue;
-                }
-                promises.push(this.sdk.document.mUpdate(index, collection, documents, { ...options })
-                    .then(promise.resolve)
-                    .catch(promise.reject));
-            }
-        }
-        await Promise.all(promises);
-    }
-    async sendReplaceBuffer(buffer, options) {
-        const promises = [];
-        for (const [index, collectionBuffer] of Object.entries(buffer.indexes)) {
-            for (const [collection, { promise, documents }] of Object.entries(collectionBuffer)) {
-                if (documents.length === 0) {
-                    promise.resolve();
-                    continue;
-                }
-                promises.push(this.sdk.document.mReplace(index, collection, documents, { ...options })
-                    .then(promise.resolve)
-                    .catch(promise.reject));
-            }
-        }
-        await Promise.all(promises);
-    }
-    async sendCreateOrReplaceBuffer(buffer, options) {
-        const promises = [];
-        for (const [index, collectionBuffer] of Object.entries(buffer.indexes)) {
-            for (const [collection, { promise, documents }] of Object.entries(collectionBuffer)) {
-                if (documents.length === 0) {
-                    promise.resolve();
-                    continue;
-                }
-                promises.push(this.sdk.document.mCreateOrReplace(index, collection, documents, { ...options })
-                    .then(promise.resolve)
-                    .catch(promise.reject));
-            }
-        }
-        await Promise.all(promises);
-    }
-    async sendGetBuffer(buffer) {
-        const promises = [];
-        for (const [index, collectionBuffer] of Object.entries(buffer.indexes)) {
-            for (const [collection, { promise, documents }] of Object.entries(collectionBuffer)) {
-                if (documents.length === 0) {
-                    promise.resolve();
-                    continue;
-                }
-                const ids = documents.map(({ _id }) => _id);
-                promises.push(this.sdk.document.mGet(index, collection, ids)
-                    .then(promise.resolve)
-                    .catch(promise.reject));
-            }
-        }
-        await Promise.all(promises);
-    }
-    async sendExistsBuffer(buffer) {
-        const promises = [];
-        for (const [index, collectionBuffer] of Object.entries(buffer.indexes)) {
-            for (const [collection, { promise, documents }] of Object.entries(collectionBuffer)) {
-                if (documents.length === 0) {
-                    promise.resolve();
-                    continue;
-                }
-                const ids = documents.map(({ _id }) => _id);
-                promises.push(this.sdk.document.mGet(index, collection, ids)
-                    .then(({ successes }) => {
-                    const successesId = successes.map(({ _id }) => _id);
-                    const exists = new Array(ids.length);
-                    for (let i = 0; i < exists.length; i++) {
-                        exists[i] = successesId.includes(ids[i]);
-                    }
-                    promise.resolve({ successes: exists });
-                })
-                    .catch(promise.reject));
-            }
-        }
-        await Promise.all(promises);
-    }
-    async sendDeleteBuffer(buffer) {
-        const promises = [];
-        for (const [index, collectionBuffer] of Object.entries(buffer.indexes)) {
-            for (const [collection, { promise, documents }] of Object.entries(collectionBuffer)) {
-                if (documents.length === 0) {
-                    promise.resolve();
-                    continue;
-                }
-                const ids = documents.map(({ _id }) => _id);
-                promises.push(this.sdk.document.mDelete(index, collection, ids)
-                    .then(promise.resolve)
-                    .catch(promise.reject));
-            }
-        }
-        await Promise.all(promises);
-    }
-}
-exports.BatchWriter = BatchWriter;
-//# sourceMappingURL=BatchWriter.js.map

package/lib/core-classes/BatchProcessing/InstrumentablePromise.d.ts

@@ -1,6 +0,0 @@
-export declare class InstrumentablePromise {
-    promise: Promise<any>;
-    resolve: (...any: any[]) => any;
-    reject: (...any: any[]) => any;
-    constructor();
-}

package/lib/core-classes/BatchProcessing/InstrumentablePromise.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InstrumentablePromise = void 0;
-class InstrumentablePromise {
-    constructor() {
-        this.promise = new Promise((resolve, reject) => {
-            this.resolve = resolve;
-            this.reject = reject;
-        });
-    }
-}
-exports.InstrumentablePromise = InstrumentablePromise;
-//# sourceMappingURL=InstrumentablePromise.js.map

package/lib/core-classes/BatchProcessing/index.d.ts

@@ -1,3 +0,0 @@
-export * from './BatchController';
-export * from './BatchWriter';
-export * from './InstrumentablePromise';

package/lib/core-classes/BatchProcessing/index.js

@@ -1,16 +0,0 @@
-"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("./BatchController"), exports);
-__exportStar(require("./BatchWriter"), exports);
-__exportStar(require("./InstrumentablePromise"), exports);
-//# sourceMappingURL=index.js.map

package/lib/core-classes/CustomMappings/DeviceMappingsManager.d.ts

@@ -1,43 +0,0 @@
-import { JSONObject } from 'kuzzle';
-export declare class DeviceMappingsManager {
-    private mappings;
-    constructor(baseMappings: JSONObject);
-    /**
-     * Register custom metadata for devices
-     *
-     * @param metadata Device custom metadata mappings
-     *
-     * @example
-     *
-     * plugin.devices.registerMetadata({
-     *   serial: { type: 'keyword' },
-     * });
-     *
-     */
-    registerMetadata(metadata: any): void;
-    /**
-     * Register custom QoS for devices
-     *
-     * @param qos Device custom QoS mappings
-     *
-     * @example
-     *
-     * plugin.devices.registerQoS({
-     *   battery: { type: 'integer' },
-     * });
-     */
-    registerQoS(qos: JSONObject): void;
-    /**
-     * Register custom measure for devices mappings
-     *
-     * @param qos Device custom measure
-     *
-     * @example
-     *
-     * plugin.devices.registerMeasure('humidity', {
-     *   value: { type: 'float' },
-     * });
-     */
-    registerMeasure(name: string, measure: JSONObject): void;
-    get(): JSONObject;
-}

package/lib/core-classes/CustomMappings/DeviceMappingsManager.js

@@ -1,71 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DeviceMappingsManager = void 0;
-const kuzzle_1 = require("kuzzle");
-class DeviceMappingsManager {
-    constructor(baseMappings) {
-        this.mappings = JSON.parse(JSON.stringify(baseMappings));
-    }
-    /**
-     * Register custom metadata for devices
-     *
-     * @param metadata Device custom metadata mappings
-     *
-     * @example
-     *
-     * plugin.devices.registerMetadata({
-     *   serial: { type: 'keyword' },
-     * });
-     *
-     */
-    registerMetadata(metadata) {
-        for (const [name, value] of Object.entries(metadata)) {
-            this.mappings.properties.metadata.properties[name] = value;
-        }
-    }
-    /**
-     * Register custom QoS for devices
-     *
-     * @param qos Device custom QoS mappings
-     *
-     * @example
-     *
-     * plugin.devices.registerQoS({
-     *   battery: { type: 'integer' },
-     * });
-     */
-    registerQoS(qos) {
-        for (const [name, value] of Object.entries(qos)) {
-            this.mappings.properties.qos.properties[name] = value;
-        }
-    }
-    /**
-     * Register custom measure for devices mappings
-     *
-     * @param qos Device custom measure
-     *
-     * @example
-     *
-     * plugin.devices.registerMeasure('humidity', {
-     *   value: { type: 'float' },
-     * });
-     */
-    registerMeasure(name, measure) {
-        if (this.mappings.properties.measures.properties[name]) {
-            throw new kuzzle_1.PluginImplementationError(`Measure "${name}" already exists.`);
-        }
-        const newMeasure = {
-            ...measure,
-            payloadUuid: { type: 'keyword' },
-            updatedAt: { type: 'date' },
-        };
-        this.mappings.properties.measures.properties[name] = {
-            properties: newMeasure
-        };
-    }
-    get() {
-        return this.mappings;
-    }
-}
-exports.DeviceMappingsManager = DeviceMappingsManager;
-//# sourceMappingURL=DeviceMappingsManager.js.map

package/lib/core-classes/MigrationService.d.ts

@@ -1,13 +0,0 @@
-import { Plugin } from 'kuzzle';
-export declare class MigrationService {
-    private config;
-    private context;
-    private prefix;
-    get sdk(): import("kuzzle").EmbeddedSDK;
-    constructor(pluginName: string, plugin: Plugin);
-    run(): Promise<void>;
-    /**
-     * Migrate the engine documents into the new config collection
-     */
-    private engineCollection;
-}

package/lib/core-classes/MigrationService.js

@@ -1,49 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MigrationService = void 0;
-class MigrationService {
-    constructor(pluginName, plugin) {
-        this.config = plugin.config;
-        this.context = plugin.context;
-        this.prefix = pluginName;
-    }
-    get sdk() {
-        return this.context.accessors.sdk;
-    }
-    async run() {
-        global.app.install(`${this.prefix}-O.3.0`, async () => {
-            await this.engineCollection();
-        });
-    }
-    /**
-     * Migrate the engine documents into the new config collection
-     */
-    async engineCollection() {
-        if (!await this.sdk.collection.exists(this.config.adminIndex, 'engines')) {
-            return;
-        }
-        this.context.log.info('Migrate engine documents into the config collection...');
-        let result = await this.sdk.document.search(this.config.adminIndex, 'engines', {}, { scroll: '1s', size: 100 });
-        let count = 0;
-        while (result) {
-            const documents = [];
-            for (const { _id, _source } of result.hits) {
-                documents.push({
-                    _id,
-                    body: {
-                        type: 'engine-device-manager',
-                        engine: { index: _source.index },
-                    },
-                });
-            }
-            await this.sdk.document.mCreate(this.config.adminIndex, this.config.configCollection, documents, {
-                strict: true,
-            });
-            count += documents.length;
-            result = await result.next();
-        }
-        this.context.log.info(`Successfully migrated ${count} documents.`);
-    }
-}
-exports.MigrationService = MigrationService;
-//# sourceMappingURL=MigrationService.js.map

package/lib/models/Catalog.d.ts

@@ -1,55 +0,0 @@
-import { JSONObject } from 'kuzzle';
-import { ConfigDocument } from './Config';
-export declare const catalogMappings: {
-    dynamic: string;
-    properties: {
-        deviceId: {
-            type: string;
-        };
-        authorized: {
-            type: string;
-        };
-        tenantId: {
-            type: string;
-        };
-        assetId: {
-            type: string;
-        };
-    };
-};
-/**
- * Provisioning catalog entry
- */
-export declare type CatalogContent = {
-    /**
-     * ID of the device
-     * (e.g. "Abeeway-123456")
-     */
-    deviceId: string;
-    /**
-     * If set to false, the device cannot register
-     */
-    authorized: boolean;
-    /**
-     * If set, the device will be attached to this tenant
-     */
-    tenantId?: string;
-    /**
-     * If set, the device will be linked to this asset
-     */
-    assetId?: string;
-};
-/**
- * Catalog configuration document
- */
-export declare class Catalog extends ConfigDocument<CatalogContent> {
-    /**
-     * Can be build either:
-     *   - with a raw config document (_id and _source properties)
-     *   - with a rule definition
-     */
-    constructor(document: CatalogContent | {
-        _id: string;
-        _source: JSONObject;
-    });
-}

package/lib/models/Catalog.js

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Catalog = exports.catalogMappings = void 0;
-const Config_1 = require("./Config");
-exports.catalogMappings = {
-    dynamic: 'strict',
-    properties: {
-        deviceId: { type: 'keyword' },
-        authorized: { type: 'boolean' },
-        tenantId: { type: 'keyword' },
-        assetId: { type: 'keyword' },
-    },
-};
-/**
- * Catalog configuration document
- */
-class Catalog extends Config_1.ConfigDocument {
-    /**
-     * Can be build either:
-     *   - with a raw config document (_id and _source properties)
-     *   - with a rule definition
-     */
-    constructor(document) {
-        if (document['_id'] || document['_source']) {
-            super(document);
-        }
-        else {
-            super({
-                _source: {
-                    type: 'catalog',
-                    catalog: document
-                }
-            });
-        }
-    }
-}
-exports.Catalog = Catalog;
-//# sourceMappingURL=Catalog.js.map

package/lib/types/AssetsHistoryContent.d.ts

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

package/lib/types/Measure.d.ts

@@ -1,54 +0,0 @@
-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/utils/events.d.ts

@@ -1,8 +0,0 @@
-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

@@ -1,17 +0,0 @@
-"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