moonfire-nvr/ui-src/lib/models/JsonWrapper.js

// vim: set et sw=2 ts=2:
//
// This file is part of Moonfire NVR, a security camera digital video recorder.
// Copyright (C) 2018 Dolf Starreveld <dolf@starreveld.com>
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// In addition, as a special exception, the copyright holders give
// permission to link the code of portions of this program with the
// OpenSSL library under certain conditions as described in each
// individual source file, and distribute linked combinations including
// the two.
//
// You must obey the GNU General Public License in all respects for all
// of the code used other than OpenSSL. If you modify file(s) with this
// exception, you may extend this exception to your version of the
// file(s), but you are not obligated to do so. If you do not wish to do
// so, delete this exception statement from your version. If you delete
// this exception statement from all source files in the program, then
// also delete it here.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

/**
 * WeakMap that keeps our private data.
 *
 * @type {WeakMap}
 */
let _json = new WeakMap();

/**
 * Class to encapsulate recording JSON data.
 * *
 * The JSON is kept internally, but in a manner that does not allow direct
 * access. If access is needed, use the "json()" method. Sub-classes for
 * specific models shoudl provide the necessary getters instead.
 */
export default class JsonWrapper {
  /**
   * Accept JSON data to be encapsulated
   *
   * @param  {object} jsonData JSON data
   */
  constructor(jsonData) {
    _json.set(this, jsonData);
  }

  /**
   * Get associated JSON object.
   *
   * Use of this should be avoided. Use functions to access the
   * data instead.
   *
   * @return {object} The JSON object.
   */
  get json() {
    return _json.get(this);
  }

  /**
   * @override
   * @return {String} String version
   */
  toString() {
    if (process.env.NODE_ENV === 'development') {
      return this.json.toString();
    } else {
      return super.toString();
    }
  }
}