jstorm
Version:
JavaScript Storage ORM (Object-Relational Mapper) for LocalStorage and Chrome Storage API
358 lines (357 loc) • 14.9 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.Model = void 0;
var JSTORM_VOLATILITY_PREFIX = "$";
var IDProvider = /** @class */ (function () {
function IDProvider() {
}
IDProvider.timestampID = function () {
return String(Date.now());
};
IDProvider.sequentialID = function (ensemble) {
if (ensemble === void 0) { ensemble = {}; }
var last = Object.keys(ensemble).map(function (id) { return parseInt(id, 10); }).sort(function (prev, next) { return (prev < next) ? -1 : 1; }).pop();
return String((last || 0) + 1);
};
// static randomUUID(): string {
// return crypto.randomUUID();
// }
IDProvider.randomShortID = function () {
return Math.random().toString(36).slice(2);
};
var _a;
_a = IDProvider;
IDProvider._nextID_ = _a.randomShortID;
return IDProvider;
}());
var Model = /** @class */ (function (_super) {
__extends(Model, _super);
function Model() {
return _super !== null && _super.apply(this, arguments) || this;
}
/**
* @private Strictly internal
*/
Model.__ns__ = function () {
var _b;
return (_b = this["_namespace_"]) !== null && _b !== void 0 ? _b : this.name;
};
/**
* @private Strictly internal
*/
Model.__rawdict__ = function () {
return __awaiter(this, void 0, void 0, function () {
var namespace, ensemble;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
namespace = this.__ns__();
return [4 /*yield*/, this._area_.get(namespace)];
case 1:
ensemble = _b.sent();
return [2 /*return*/, Object.keys((ensemble === null || ensemble === void 0 ? void 0 : ensemble[namespace]) || {}).length != 0 ? ensemble[namespace] : (this.default || {})];
}
});
});
};
Model.useStorage = function (area) {
this._area_ = area;
};
Model.new = function (props, _id) {
var instance = new this(props);
instance["_id"] = _id !== null && _id !== void 0 ? _id : null;
Object.entries(props || {}).map(function (_b) {
var key = _b[0], value = _b[1];
instance[key] = value;
});
return instance;
};
Model.create = function (props) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_b) {
switch (_b.label) {
case 0: return [4 /*yield*/, this["new"](props).save()];
case 1: return [2 /*return*/, _b.sent()];
}
});
});
};
Model.list = function () {
return __awaiter(this, void 0, void 0, function () {
var dict, res, _b, _c, _d, _i, id, instance;
return __generator(this, function (_e) {
switch (_e.label) {
case 0: return [4 /*yield*/, this.__rawdict__()];
case 1:
dict = _e.sent();
res = [];
_b = dict;
_c = [];
for (_d in _b)
_c.push(_d);
_i = 0;
_e.label = 2;
case 2:
if (!(_i < _c.length)) return [3 /*break*/, 5];
_d = _c[_i];
if (!(_d in _b)) return [3 /*break*/, 4];
id = _d;
instance = this["new"](dict[id], id);
return [4 /*yield*/, instance.__decode__(dict[id])];
case 3:
_e.sent();
res.push(instance);
_e.label = 4;
case 4:
_i++;
return [3 /*break*/, 2];
case 5: return [2 /*return*/, res];
}
});
});
};
Model.filter = function (func) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_b) {
switch (_b.label) {
case 0: return [4 /*yield*/, this.list()];
case 1: return [2 /*return*/, (_b.sent()).filter(func)];
}
});
});
};
Model.find = function (id) {
return __awaiter(this, void 0, void 0, function () {
var dict, entry, instance;
var _b;
return __generator(this, function (_c) {
switch (_c.label) {
case 0: return [4 /*yield*/, this.__rawdict__()];
case 1:
dict = _c.sent();
entry = dict[id] || ((_b = this.default) === null || _b === void 0 ? void 0 : _b[id]) || null;
if (!entry)
return [2 /*return*/, null];
instance = this["new"](entry, id);
return [4 /*yield*/, instance.__decode__(entry)];
case 2:
_c.sent();
return [2 /*return*/, instance];
}
});
});
};
Model.drop = function () {
return __awaiter(this, void 0, void 0, function () {
var _b;
return __generator(this, function (_c) {
switch (_c.label) {
case 0: return [4 /*yield*/, this._area_.set((_b = {}, _b[this.__ns__()] = {}, _b))];
case 1:
_c.sent();
return [2 /*return*/];
}
});
});
};
Model.prototype.save = function () {
return __awaiter(this, void 0, void 0, function () {
var parent, dict;
var _b;
return __generator(this, function (_c) {
switch (_c.label) {
case 0:
parent = this.constructor;
return [4 /*yield*/, parent.__rawdict__()];
case 1:
dict = _c.sent();
if (!this._id)
this._id = parent._nextID_(dict);
dict[this._id] = this.__volatilize__();
return [4 /*yield*/, parent._area_.set((_b = {}, _b[parent.__ns__()] = dict, _b))];
case 2:
_c.sent();
return [2 /*return*/, this];
}
});
});
};
Model.prototype.delete = function () {
return __awaiter(this, void 0, void 0, function () {
var parent, dict;
var _b;
return __generator(this, function (_c) {
switch (_c.label) {
case 0:
parent = this.constructor;
return [4 /*yield*/, parent.__rawdict__()];
case 1:
dict = _c.sent();
delete dict[this._id];
return [4 /*yield*/, parent._area_.set((_b = {}, _b[parent.__ns__()] = dict, _b))];
case 2:
_c.sent();
delete this._id;
return [2 /*return*/, this];
}
});
});
};
Model.prototype.update = function (props) {
return __awaiter(this, void 0, void 0, function () {
var _this = this;
return __generator(this, function (_b) {
Object.keys(props).map(function (key) {
if (_this.hasOwnProperty(key))
_this[key] = props[key];
});
return [2 /*return*/, this.save()];
});
});
};
/**
* @private Strictly internal
* @param {Object} raw
* @returns {Promise<T>}
*/
Model.prototype.__decode__ = function (raw) {
return __awaiter(this, void 0, void 0, function () {
var schema, _b, _c, _d, _i, key, _e, _f;
return __generator(this, function (_g) {
switch (_g.label) {
case 0:
schema = this.constructor.schema;
_b = schema;
_c = [];
for (_d in _b)
_c.push(_d);
_i = 0;
_g.label = 1;
case 1:
if (!(_i < _c.length)) return [3 /*break*/, 5];
_d = _c[_i];
if (!(_d in _b)) return [3 /*break*/, 4];
key = _d;
if (!this.hasOwnProperty(key))
return [3 /*break*/, 4];
if (!raw.hasOwnProperty(key))
return [3 /*break*/, 4];
if (key.startsWith(JSTORM_VOLATILITY_PREFIX))
return [3 /*break*/, 4];
if (!(typeof schema[key].load == "function")) return [3 /*break*/, 3];
_e = this;
_f = key;
return [4 /*yield*/, schema[key].load(raw[key])];
case 2:
_e[_f] = _g.sent();
return [3 /*break*/, 4];
case 3:
this[key] = raw[key];
_g.label = 4;
case 4:
_i++;
return [3 /*break*/, 1];
case 5: return [2 /*return*/, this];
}
});
});
};
/**
* @private Strictly internal
* @returns {Promise<{ [key: string]: any }>}
*/
Model.prototype.__volatilize__ = function () {
var _this = this;
Object.keys(this).map(function (key) {
if (!_this.hasOwnProperty(key))
return _this[key] = undefined;
if (key.startsWith(JSTORM_VOLATILITY_PREFIX))
return _this[key] = undefined;
});
return this;
};
var _b;
/**
* _area_
* Overwrite this proeprty if you want to use your custom storage.
* e.g.,
* class Player extends Model {
* static overwrite _area_ = chrome.storage.session;
* }
*
* You ain't need it because you can just use followings to embed
* standard storage interfaces.
*
* // For chrome.storage.local,
* import { Model } from "jstorm/chrome/local";
*
* // For chrome.storage.sync,
* import { Model } from "jstorm/chrome/sync";
*
* // For window.localStorage,
* import { Model } from "jstorm/browser/local";
*
* // For window.sessionStorage,
* import { Model } from "jstorm/browser/session";
*/
Model._area_ = (typeof chrome == "undefined" ? null : (_b = chrome.storage) === null || _b === void 0 ? void 0 : _b.local);
/**
* schema
* Overwite this property to spacify validation and relation rules of this Model.
* Please check https://github.com/otiai10/jstorm#schema for more detail.
*/
Model.schema = {};
return Model;
}(IDProvider));
exports.Model = Model;