unifi-client
Version:
NodeJs client for Unifi products (https://www.ui.com/)
219 lines (218 loc) • 10.4 kB
JavaScript
"use strict";
var __extends = (this && this.__extends) || (function () {
var extendStatics = function (d, b) {
extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
return extendStatics(d, b);
};
return function (d, b) {
if (typeof b !== "function" && b !== null)
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
};
})();
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
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 (g && (g = 0, op[0] && (_ = 0)), _) 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 };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.Clients = void 0;
var Errors_1 = require("../Errors");
var _ObjectSubSite_1 = require("../commons/_ObjectSubSite");
var Client_1 = require("./Client");
var Validate_1 = require("../commons/Validate");
var util_1 = require("../util");
var Clients = /** @class */ (function (_super) {
__extends(Clients, _super);
function Clients() {
return _super !== null && _super.apply(this, arguments) || this;
}
Clients.prototype.create = function (client) {
return __awaiter(this, void 0, void 0, function () {
var created;
var _a, _b, _c;
return __generator(this, function (_d) {
switch (_d.label) {
case 0:
if (Validate_1.Validate.isUndefined(client.mac)) {
throw new Errors_1.ClientError('mac is mandatory', Errors_1.EErrorsCodes.BAD_PARAMETERS);
}
return [4 /*yield*/, this.instance.post('/rest/user', {
mac: client.mac.toLowerCase(),
user_group_id: (_a = client.user_group_id) !== null && _a !== void 0 ? _a : client.usergroup_id,
name: client.name,
note: client.note,
noted: client.noted || !!client.note,
is_guest: client.is_guest,
is_wired: client.is_wired,
fixed_ip: client.fixed_ip,
network_id: client.network_id,
use_fixedip: (_b = client.use_fixedip) !== null && _b !== void 0 ? _b : !!client.fixed_ip
})];
case 1:
created = (_c = (_d.sent()).data) === null || _c === void 0 ? void 0 : _c.data;
if ((created === null || created === void 0 ? void 0 : created.length) > 0) {
return [2 /*return*/, this.mapObject(Client_1.Client, created[0])];
}
return [2 /*return*/];
}
});
});
};
/**
* get a client by _id
* @param _id - unifiId
*/
Clients.prototype.getById = function (_id) {
return __awaiter(this, void 0, void 0, function () {
var result;
var _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0: return [4 /*yield*/, this.instance.get('/rest/user/:_id', {
urlParams: {
_id: _id
}
})];
case 1:
result = (_a = (_b.sent()).data) === null || _a === void 0 ? void 0 : _a.data;
if ((result === null || result === void 0 ? void 0 : result.length) > 0) {
return [2 /*return*/, this.mapObject(Client_1.Client, result[0])];
}
return [2 /*return*/];
}
});
});
};
/**
* get a Client by mac
* call /stat/sta/:mac ( seems to return same as /stat/user/:mac )
* @param mac - the macAddress
*/
Clients.prototype.getByMac = function (mac) {
return __awaiter(this, void 0, void 0, function () {
var macAddress, result;
var _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
macAddress = (0, util_1.formatMacAddress)(mac, ':');
return [4 /*yield*/, this.instance.get("/stat/sta/".concat(macAddress))];
case 1:
result = (_a = (_b.sent()).data) === null || _a === void 0 ? void 0 : _a.data;
if (!(result === null || result === void 0 ? void 0 : result.length)) {
return [2 /*return*/];
}
return [2 /*return*/, this.mapObject(Client_1.Client, result[0])];
}
});
});
};
// other way to do a list, seems to return same results...
// but available if works better for you
Clients.prototype.list2 = function (params) {
return __awaiter(this, void 0, void 0, function () {
var _this = this;
var _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0: return [4 /*yield*/, this.instance.get('/list/user', {
params: params
})];
case 1: return [2 /*return*/, (((_a = (_b.sent()).data) === null || _a === void 0 ? void 0 : _a.data) || []).map(function (r) { return _this.mapObject(Client_1.Client, r); })];
}
});
});
};
// list online clients
// less results but more detailed ( same as the "clients" view )
Clients.prototype.list3 = function (params) {
return __awaiter(this, void 0, void 0, function () {
var res;
var _this = this;
var _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0: return [4 /*yield*/, this.instance.get('/stat/sta', {
params: params
})];
case 1:
res = ((_a = (_b.sent()).data) === null || _a === void 0 ? void 0 : _a.data) || [];
return [2 /*return*/, res.map(function (r) { return _this.mapObject(Client_1.Client, r); })];
}
});
});
};
/**
* Use this function to list clients
*
* example to get all blocked user in the last 10 hours
* ```
* list({
* type: 'blocked',
* conn: 'all',
* within: 10
* });
* ```
*
* example to get all user from the last 2 hours
* ```
* list({
* type: 'all',
* conn: 'all',
* within: 2
* });
* ```
*/
Clients.prototype.list = function (params) {
return __awaiter(this, void 0, void 0, function () {
var _this = this;
var _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0: return [4 /*yield*/, this.instance.get('/stat/alluser', {
params: params
})];
case 1: return [2 /*return*/, (((_a = (_b.sent()).data) === null || _a === void 0 ? void 0 : _a.data) || []).map(function (r) { return _this.mapObject(Client_1.Client, r); })];
}
});
});
};
return Clients;
}(_ObjectSubSite_1._ObjectSubSite));
exports.Clients = Clients;