@hello.nrfcloud.com/proto-map 4.0.0

package/dist/lwm2m/LwM2MObjectID.js

@@ -0,0 +1,57 @@
+/**
+ * The LwM2M Object IDs defined in this repo.
+ */ export var LwM2MObjectID;
+(function(LwM2MObjectID) {
+    /**
+     * Geolocation (14201)
+     *
+     * Describes the geo location of a device
+     */ LwM2MObjectID[LwM2MObjectID["Geolocation_14201"] = 14201] = "Geolocation_14201";
+    /**
+     * Battery and Power (14202)
+     *
+     * Information about the battery and power status of the device.
+     */ LwM2MObjectID[LwM2MObjectID["BatteryAndPower_14202"] = 14202] = "BatteryAndPower_14202";
+    /**
+     * Connection information (14203)
+     *
+     * Details about the device's connection.
+     */ LwM2MObjectID[LwM2MObjectID["ConnectionInformation_14203"] = 14203] = "ConnectionInformation_14203";
+    /**
+     * Device information (14204)
+     *
+     * Details about the device's connection.
+     */ LwM2MObjectID[LwM2MObjectID["DeviceInformation_14204"] = 14204] = "DeviceInformation_14204";
+    /**
+     * Environment (14205)
+     *
+     * Environment information.
+     */ LwM2MObjectID[LwM2MObjectID["Environment_14205"] = 14205] = "Environment_14205";
+    /**
+     * Solar charge (14210)
+     *
+     * Measurements from the solar shield.
+     */ LwM2MObjectID[LwM2MObjectID["SolarCharge_14210"] = 14210] = "SolarCharge_14210";
+    /**
+     * Button press (14220)
+     *
+     * Describes a button press event.
+     */ LwM2MObjectID[LwM2MObjectID["ButtonPress_14220"] = 14220] = "ButtonPress_14220";
+    /**
+     * Sea Water Level (14230)
+     *
+     * Describes observed sea water level.
+     */ LwM2MObjectID[LwM2MObjectID["SeaWaterLevel_14230"] = 14230] = "SeaWaterLevel_14230";
+})(LwM2MObjectID || (LwM2MObjectID = {}));
+/**
+ * The LwM2M Object IDs defined in this repo.
+ */ export var LwM2MObjectIDs = [
+    14201,
+    14202,
+    14203,
+    14204,
+    14205,
+    14210,
+    14220,
+    14230
+];

package/dist/lwm2m/ParsedLwM2MObjectDefinition.js

@@ -0,0 +1 @@
+export { };

package/dist/lwm2m/check-lwm2m-rules.js

@@ -0,0 +1,480 @@
+function _array_like_to_array(arr, len) {
+    if (len == null || len > arr.length) len = arr.length;
+    for(var i = 0, arr2 = new Array(len); i < len; i++)arr2[i] = arr[i];
+    return arr2;
+}
+function _array_with_holes(arr) {
+    if (Array.isArray(arr)) return arr;
+}
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
+    try {
+        var info = gen[key](arg);
+        var value = info.value;
+    } catch (error) {
+        reject(error);
+        return;
+    }
+    if (info.done) {
+        resolve(value);
+    } else {
+        Promise.resolve(value).then(_next, _throw);
+    }
+}
+function _async_to_generator(fn) {
+    return function() {
+        var self = this, args = arguments;
+        return new Promise(function(resolve, reject) {
+            var gen = fn.apply(self, args);
+            function _next(value) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
+            }
+            function _throw(err) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
+            }
+            _next(undefined);
+        });
+    };
+}
+function _define_property(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+function _iterable_to_array_limit(arr, i) {
+    var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"];
+    if (_i == null) return;
+    var _arr = [];
+    var _n = true;
+    var _d = false;
+    var _s, _e;
+    try {
+        for(_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true){
+            _arr.push(_s.value);
+            if (i && _arr.length === i) break;
+        }
+    } catch (err) {
+        _d = true;
+        _e = err;
+    } finally{
+        try {
+            if (!_n && _i["return"] != null) _i["return"]();
+        } finally{
+            if (_d) throw _e;
+        }
+    }
+    return _arr;
+}
+function _non_iterable_rest() {
+    throw new TypeError("Invalid attempt to destructure non-iterable instance.\\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
+}
+function _object_spread(target) {
+    for(var i = 1; i < arguments.length; i++){
+        var source = arguments[i] != null ? arguments[i] : {};
+        var ownKeys = Object.keys(source);
+        if (typeof Object.getOwnPropertySymbols === "function") {
+            ownKeys = ownKeys.concat(Object.getOwnPropertySymbols(source).filter(function(sym) {
+                return Object.getOwnPropertyDescriptor(source, sym).enumerable;
+            }));
+        }
+        ownKeys.forEach(function(key) {
+            _define_property(target, key, source[key]);
+        });
+    }
+    return target;
+}
+function ownKeys(object, enumerableOnly) {
+    var keys = Object.keys(object);
+    if (Object.getOwnPropertySymbols) {
+        var symbols = Object.getOwnPropertySymbols(object);
+        if (enumerableOnly) {
+            symbols = symbols.filter(function(sym) {
+                return Object.getOwnPropertyDescriptor(object, sym).enumerable;
+            });
+        }
+        keys.push.apply(keys, symbols);
+    }
+    return keys;
+}
+function _object_spread_props(target, source) {
+    source = source != null ? source : {};
+    if (Object.getOwnPropertyDescriptors) {
+        Object.defineProperties(target, Object.getOwnPropertyDescriptors(source));
+    } else {
+        ownKeys(Object(source)).forEach(function(key) {
+            Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
+        });
+    }
+    return target;
+}
+function _object_without_properties(source, excluded) {
+    if (source == null) return {};
+    var target = _object_without_properties_loose(source, excluded);
+    var key, i;
+    if (Object.getOwnPropertySymbols) {
+        var sourceSymbolKeys = Object.getOwnPropertySymbols(source);
+        for(i = 0; i < sourceSymbolKeys.length; i++){
+            key = sourceSymbolKeys[i];
+            if (excluded.indexOf(key) >= 0) continue;
+            if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue;
+            target[key] = source[key];
+        }
+    }
+    return target;
+}
+function _object_without_properties_loose(source, excluded) {
+    if (source == null) return {};
+    var target = {};
+    var sourceKeys = Object.keys(source);
+    var key, i;
+    for(i = 0; i < sourceKeys.length; i++){
+        key = sourceKeys[i];
+        if (excluded.indexOf(key) >= 0) continue;
+        target[key] = source[key];
+    }
+    return target;
+}
+function _sliced_to_array(arr, i) {
+    return _array_with_holes(arr) || _iterable_to_array_limit(arr, i) || _unsupported_iterable_to_array(arr, i) || _non_iterable_rest();
+}
+function _unsupported_iterable_to_array(o, minLen) {
+    if (!o) return;
+    if (typeof o === "string") return _array_like_to_array(o, minLen);
+    var n = Object.prototype.toString.call(o).slice(8, -1);
+    if (n === "Object" && o.constructor) n = o.constructor.name;
+    if (n === "Map" || n === "Set") return Array.from(n);
+    if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _array_like_to_array(o, minLen);
+}
+function _ts_generator(thisArg, body) {
+    var f, y, t, g, _ = {
+        label: 0,
+        sent: function() {
+            if (t[0] & 1) throw t[1];
+            return t[1];
+        },
+        trys: [],
+        ops: []
+    };
+    return g = {
+        next: verb(0),
+        "throw": verb(1),
+        "return": verb(2)
+    }, typeof Symbol === "function" && (g[Symbol.iterator] = function() {
+        return this;
+    }), g;
+    function verb(n) {
+        return function(v) {
+            return step([
+                n,
+                v
+            ]);
+        };
+    }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while(_)try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [
+                op[0] & 2,
+                t.value
+            ];
+            switch(op[0]){
+                case 0:
+                case 1:
+                    t = op;
+                    break;
+                case 4:
+                    _.label++;
+                    return {
+                        value: op[1],
+                        done: false
+                    };
+                case 5:
+                    _.label++;
+                    y = op[1];
+                    op = [
+                        0
+                    ];
+                    continue;
+                case 7:
+                    op = _.ops.pop();
+                    _.trys.pop();
+                    continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
+                        _ = 0;
+                        continue;
+                    }
+                    if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
+                        _.label = op[1];
+                        break;
+                    }
+                    if (op[0] === 6 && _.label < t[1]) {
+                        _.label = t[1];
+                        t = op;
+                        break;
+                    }
+                    if (t && _.label < t[2]) {
+                        _.label = t[2];
+                        _.ops.push(op);
+                        break;
+                    }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop();
+                    continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) {
+            op = [
+                6,
+                e
+            ];
+            y = 0;
+        } finally{
+            f = t = 0;
+        }
+        if (op[0] & 5) throw op[1];
+        return {
+            value: op[0] ? op[1] : void 0,
+            done: true
+        };
+    }
+}
+function _ts_values(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function() {
+            if (o && i >= o.length) o = void 0;
+            return {
+                value: o && o[i++],
+                done: !o
+            };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+}
+import chalk from "chalk";
+import { readFile, readdir, stat } from "node:fs/promises";
+import path, { parse } from "node:path";
+import assert from "node:assert/strict";
+import xml2js from "xml2js";
+import { exec } from "node:child_process";
+import { unwrapNestedArray } from "./unwrapNestedArray.js";
+import { LWM2MObjectDefinition } from "./LWM2MObjectDefinition.js";
+import { validate } from "../validate.js";
+import { parseRangeEnumeration } from "./parseRangeEnumeration.js";
+var v = validate(LWM2MObjectDefinition);
+var listLwm2mDefinitions = function() {
+    var _ref = _async_to_generator(function(modelDir) {
+        var defs, files, _iteratorNormalCompletion, _didIteratorError, _iteratorError, _loop, _iterator, _step, err;
+        return _ts_generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    defs = [];
+                    return [
+                        4,
+                        readdir(modelDir)
+                    ];
+                case 1:
+                    files = _state.sent();
+                    _iteratorNormalCompletion = true, _didIteratorError = false, _iteratorError = undefined;
+                    _state.label = 2;
+                case 2:
+                    _state.trys.push([
+                        2,
+                        7,
+                        8,
+                        9
+                    ]);
+                    _loop = function() {
+                        var _ref, file, _TimeResources_, _TimeResources_1, objectDefinitionFile, schemaValidated, ObjectID, ObjectURN, definition, _, objectDef, maybeValid, _maybeValid_value, Name, Resources, TimeResources, _iteratorNormalCompletion, _didIteratorError, _iteratorError, _iterator, _step1, _step_value, id, resource, _resource_Units;
+                        return _ts_generator(this, function(_state) {
+                            switch(_state.label){
+                                case 0:
+                                    _ref = _step.value;
+                                    file = _ref;
+                                    if (!file.endsWith(".xml")) return [
+                                        2,
+                                        "continue"
+                                    ];
+                                    console.log(chalk.white("\xb7"), chalk.white.bold(file));
+                                    assert.match(file, /^[0-9]+\.xml$/, "LwM2M object definition files must only have numbers in their file names");
+                                    console.log(chalk.green("✔"), chalk.gray("File name is correct"));
+                                    objectDefinitionFile = path.join(modelDir, file);
+                                    return [
+                                        4,
+                                        stat(objectDefinitionFile)
+                                    ];
+                                case 1:
+                                    if (_state.sent().isDirectory()) return [
+                                        2,
+                                        "continue"
+                                    ];
+                                    return [
+                                        4,
+                                        new Promise(function(resolve) {
+                                            return exec("xmllint --noout --schema ".concat(path.join(process.cwd(), "lwm2m", "LWM2M-v1_1.xsd"), " ").concat(objectDefinitionFile), function(error, _, stderr) {
+                                                if (error) {
+                                                    console.error(stderr);
+                                                    return resolve(false);
+                                                }
+                                                resolve(true);
+                                            });
+                                        })
+                                    ];
+                                case 2:
+                                    schemaValidated = _state.sent();
+                                    assert.equal(schemaValidated, true, "");
+                                    console.log(chalk.green("✔"), chalk.gray("Is a valid LwM2M object definition"));
+                                    ObjectID = parseInt(parse(objectDefinitionFile).name, 10);
+                                    assert.equal(ObjectID > 14200, true, "ObjectID must be greater than 14200");
+                                    assert.equal(ObjectID < 15000, true, "ObjectID must be smaller than 15000");
+                                    ObjectURN = "urn:oma:lwm2m:x:".concat(ObjectID);
+                                    _ = xml2js.parseStringPromise;
+                                    return [
+                                        4,
+                                        readFile(objectDefinitionFile, "utf-8")
+                                    ];
+                                case 3:
+                                    return [
+                                        4,
+                                        _.apply(xml2js, [
+                                            _state.sent()
+                                        ])
+                                    ];
+                                case 4:
+                                    definition = unwrapNestedArray.apply(void 0, [
+                                        _state.sent()
+                                    ]).LWM2M.Object;
+                                    assert.equal(ObjectID.toString(), definition.ObjectID, "ObjectID must match filename");
+                                    assert.equal(ObjectURN, definition.ObjectURN, "ObjectURN must follow schema");
+                                    console.log(chalk.green("✔"), chalk.blue(ObjectURN), chalk.gray("ObjectID and URN match filename and schema"));
+                                    objectDef = _object_spread_props(_object_spread({}, definition), {
+                                        LWM2MVersion: "1.1",
+                                        Resources: definition.Resources.Item.reduce(function(resources, _param) {
+                                            var $ = _param.$, item = _object_without_properties(_param, [
+                                                "$"
+                                            ]);
+                                            if (resources[$.ID] !== undefined) throw new Error("Duplicate resource ID: ".concat($.ID));
+                                            if (item.RangeEnumeration.length > 0) {
+                                                var maybeRange = parseRangeEnumeration(item.RangeEnumeration);
+                                                if ("error" in maybeRange) throw maybeRange.error;
+                                            }
+                                            return _object_spread_props(_object_spread({}, resources), _define_property({}, $.ID, item));
+                                        }, {})
+                                    });
+                                    maybeValid = v(objectDef);
+                                    if ("errors" in maybeValid) {
+                                        console.error(maybeValid.errors);
+                                        throw new Error("The definition should be valid!");
+                                    }
+                                    console.log(chalk.green("✔"), chalk.gray("LwM2M limitations are honored"));
+                                    defs.push(maybeValid.value);
+                                    _maybeValid_value = maybeValid.value, Name = _maybeValid_value.Name, Resources = _maybeValid_value.Resources;
+                                    TimeResources = Object.values(Resources).filter(function(param) {
+                                        var Type = param.Type;
+                                        return Type === "Time";
+                                    });
+                                    assert.equal(TimeResources.length, 1, "Objects must define one Time resource");
+                                    assert.equal((_TimeResources_ = TimeResources[0]) === null || _TimeResources_ === void 0 ? void 0 : _TimeResources_.Mandatory, "Mandatory", "The Time resources must be mandatory.");
+                                    console.log(chalk.green("✔"), chalk.gray("Object has one time resource (".concat((_TimeResources_1 = TimeResources[0]) === null || _TimeResources_1 === void 0 ? void 0 : _TimeResources_1.Name, ")")));
+                                    console.log("".concat(chalk.yellow(ObjectID), ":"), chalk.white(Name));
+                                    _iteratorNormalCompletion = true, _didIteratorError = false, _iteratorError = undefined;
+                                    try {
+                                        for(_iterator = Object.entries(Resources)[Symbol.iterator](); !(_iteratorNormalCompletion = (_step1 = _iterator.next()).done); _iteratorNormalCompletion = true){
+                                            _step_value = _sliced_to_array(_step1.value, 2), id = _step_value[0], resource = _step_value[1];
+                                            ;
+                                            console.log("".concat(chalk.gray(ObjectID), ".").concat(chalk.yellow(id), ":"), chalk.white(resource.Name), "".concat(chalk.gray(resource.Type), " ").concat(chalk.gray("(".concat((_resource_Units = resource.Units) !== null && _resource_Units !== void 0 ? _resource_Units : "no unit", ")"))));
+                                        }
+                                    } catch (err) {
+                                        _didIteratorError = true;
+                                        _iteratorError = err;
+                                    } finally{
+                                        try {
+                                            if (!_iteratorNormalCompletion && _iterator.return != null) {
+                                                _iterator.return();
+                                            }
+                                        } finally{
+                                            if (_didIteratorError) {
+                                                throw _iteratorError;
+                                            }
+                                        }
+                                    }
+                                    return [
+                                        2
+                                    ];
+                            }
+                        });
+                    };
+                    _iterator = files[Symbol.iterator]();
+                    _state.label = 3;
+                case 3:
+                    if (!!(_iteratorNormalCompletion = (_step = _iterator.next()).done)) return [
+                        3,
+                        6
+                    ];
+                    return [
+                        5,
+                        _ts_values(_loop())
+                    ];
+                case 4:
+                    _state.sent();
+                    _state.label = 5;
+                case 5:
+                    _iteratorNormalCompletion = true;
+                    return [
+                        3,
+                        3
+                    ];
+                case 6:
+                    return [
+                        3,
+                        9
+                    ];
+                case 7:
+                    err = _state.sent();
+                    _didIteratorError = true;
+                    _iteratorError = err;
+                    return [
+                        3,
+                        9
+                    ];
+                case 8:
+                    try {
+                        if (!_iteratorNormalCompletion && _iterator.return != null) {
+                            _iterator.return();
+                        }
+                    } finally{
+                        if (_didIteratorError) {
+                            throw _iteratorError;
+                        }
+                    }
+                    return [
+                        7
+                    ];
+                case 9:
+                    return [
+                        2,
+                        defs
+                    ];
+            }
+        });
+    });
+    return function listLwm2mDefinitions(modelDir) {
+        return _ref.apply(this, arguments);
+    };
+}();
+// LwM2M
+console.log(chalk.gray("LwM2M rules check"));
+console.log("");
+var lwm2mDir = path.join(process.cwd(), "lwm2m");
+var lwm2mDefinitions = await listLwm2mDefinitions(lwm2mDir);
+assert.equal(lwm2mDefinitions.length > 0, true, "LwM2M objects must be defined.");