@analytics/remote-storage-utils
Version:
Storage utilities for cross domain localStorage access, with permissions
244 lines (235 loc) • 13.6 kB
JavaScript
;
Object.defineProperty(exports, '__esModule', { value: true });
var crossStorage = require('cross-storage');
var typeUtils = require('@analytics/type-utils');
function _regenerator() { /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/babel/babel/blob/main/packages/babel-helpers/LICENSE */ var e, t, r = "function" == typeof Symbol ? Symbol : {}, n = r.iterator || "@@iterator", o = r.toStringTag || "@@toStringTag"; function i(r, n, o, i) { var c = n && n.prototype instanceof Generator ? n : Generator, u = Object.create(c.prototype); return _regeneratorDefine2(u, "_invoke", function (r, n, o) { var i, c, u, f = 0, p = o || [], y = !1, G = { p: 0, n: 0, v: e, a: d, f: d.bind(e, 4), d: function d(t, r) { return i = t, c = 0, u = e, G.n = r, a; } }; function d(r, n) { for (c = r, u = n, t = 0; !y && f && !o && t < p.length; t++) { var o, i = p[t], d = G.p, l = i[2]; r > 3 ? (o = l === n) && (u = i[(c = i[4]) ? 5 : (c = 3, 3)], i[4] = i[5] = e) : i[0] <= d && ((o = r < 2 && d < i[1]) ? (c = 0, G.v = n, G.n = i[1]) : d < l && (o = r < 3 || i[0] > n || n > l) && (i[4] = r, i[5] = n, G.n = l, c = 0)); } if (o || r > 1) return a; throw y = !0, n; } return function (o, p, l) { if (f > 1) throw TypeError("Generator is already running"); for (y && 1 === p && d(p, l), c = p, u = l; (t = c < 2 ? e : u) || !y;) { i || (c ? c < 3 ? (c > 1 && (G.n = -1), d(c, u)) : G.n = u : G.v = u); try { if (f = 2, i) { if (c || (o = "next"), t = i[o]) { if (!(t = t.call(i, u))) throw TypeError("iterator result is not an object"); if (!t.done) return t; u = t.value, c < 2 && (c = 0); } else 1 === c && (t = i["return"]) && t.call(i), c < 2 && (u = TypeError("The iterator does not provide a '" + o + "' method"), c = 1); i = e; } else if ((t = (y = G.n < 0) ? u : r.call(n, G)) !== a) break; } catch (t) { i = e, c = 1, u = t; } finally { f = 1; } } return { value: t, done: y }; }; }(r, o, i), !0), u; } var a = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} t = Object.getPrototypeOf; var c = [][n] ? t(t([][n]())) : (_regeneratorDefine2(t = {}, n, function () { return this; }), t), u = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(c); function f(e) { return Object.setPrototypeOf ? Object.setPrototypeOf(e, GeneratorFunctionPrototype) : (e.__proto__ = GeneratorFunctionPrototype, _regeneratorDefine2(e, o, "GeneratorFunction")), e.prototype = Object.create(u), e; } return GeneratorFunction.prototype = GeneratorFunctionPrototype, _regeneratorDefine2(u, "constructor", GeneratorFunctionPrototype), _regeneratorDefine2(GeneratorFunctionPrototype, "constructor", GeneratorFunction), GeneratorFunction.displayName = "GeneratorFunction", _regeneratorDefine2(GeneratorFunctionPrototype, o, "GeneratorFunction"), _regeneratorDefine2(u), _regeneratorDefine2(u, o, "Generator"), _regeneratorDefine2(u, n, function () { return this; }), _regeneratorDefine2(u, "toString", function () { return "[object Generator]"; }), (_regenerator = function _regenerator() { return { w: i, m: f }; })(); }
function _regeneratorDefine2(e, r, n, t) { var i = Object.defineProperty; try { i({}, "", {}); } catch (e) { i = 0; } _regeneratorDefine2 = function _regeneratorDefine(e, r, n, t) { if (r) i ? i(e, r, { value: n, enumerable: !t, configurable: !t, writable: !t }) : e[r] = n;else { var o = function o(r, n) { _regeneratorDefine2(e, r, function (e) { return this._invoke(r, n, e); }); }; o("next", 0), o("throw", 1), o("return", 2); } }, _regeneratorDefine2(e, r, n, t); }
function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
function asyncGeneratorStep(n, t, e, r, o, a, c) { try { var i = n[a](c), u = i.value; } catch (n) { return void e(n); } i.done ? t(u) : Promise.resolve(u).then(r, o); }
function _asyncToGenerator(n) { return function () { var t = this, e = arguments; return new Promise(function (r, o) { var a = n.apply(t, e); function _next(n) { asyncGeneratorStep(a, r, o, _next, _throw, "next", n); } function _throw(n) { asyncGeneratorStep(a, r, o, _next, _throw, "throw", n); } _next(void 0); }); }; }
function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
/**
* Constructs a new cross storage client
* @param {string} url The url to a cross storage hub
* @param {object} [opts] An optional object containing additional options
* @param {object} [opts.timeout] timeout
* @param {object} [opts.frameId] frameId
* @example
* const storage = new RemoteStorage('https://example.com/storage.html')
* @example
* const storage = new RemoteStorage('https://example.com/storage.html', {
* timeout: 5000,
* frameId: 'storageFrame'
* })
**/
var RemoteStorage = /*#__PURE__*/function () {
function RemoteStorage(url, opts) {
_classCallCheck(this, RemoteStorage);
if (typeUtils.isBrowser) this.storage = new crossStorage.CrossStorageClient(url, opts);
}
return _createClass(RemoteStorage, [{
key: "getItem",
value: function getItem(keys) {
return getRemoteItem(keys, this.storage);
}
}, {
key: "setItem",
value: function setItem(key, value) {
var opts = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
return setRemoteItem(key, value, opts, this.storage);
}
}]);
}();
function getRemoteItem(_x, _x2) {
return _getRemoteItem.apply(this, arguments);
}
function _getRemoteItem() {
_getRemoteItem = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee(keys, instance) {
var remoteKeys, promises;
return _regenerator().w(function (_context) {
while (1) switch (_context.n) {
case 0:
remoteKeys = Array.isArray(keys) ? keys : [keys];
promises = remoteKeys.map(function (name) {
return getRemoteItemRaw(name, instance);
});
return _context.a(2, Promise.all(promises).then(function (values) {
return values.map(function (val) {
return safeParse(val);
});
}).then(function (data) {
// If singular return single value
if (data.length === 1) {
return data[0];
}
// Else return mapped keys
return remoteKeys.reduce(function (acc, curr, i) {
acc[curr] = data[i];
return acc;
}, {});
}));
}
}, _callee);
}));
return _getRemoteItem.apply(this, arguments);
}
function formatArgs(key, value) {
var opts = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
var instance = arguments.length > 3 ? arguments[3] : undefined;
var storage = opts._id ? opts : instance;
if (typeUtils.isObject(key)) {
return _objectSpread(_objectSpread({}, key), {}, {
storage: typeUtils.isObject(value) && value._id ? value : storage
});
}
var options = !opts._id ? opts : {};
return _objectSpread({
key: key,
value: value,
storage: storage
}, options);
}
/**
* setRemoteItem
* @param {string} storageKey - localStorage key
* @param {string} storageValue - localStorage value
* @param {[function]} resolve - custom resolver function if value already set
* @param {[functiontype]} instance [description]
*/
function setRemoteItem(_x3, _x4) {
return _setRemoteItem.apply(this, arguments);
}
/**
* Get value from remote storage
* @param {String} key - localStorage key
* @return {Promise} - resolved value
*/
function _setRemoteItem() {
_setRemoteItem = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee2(storageKey, storageValue) {
var opts,
instance,
_formatArgs,
key,
value,
resolve,
storage,
remoteValueRaw,
remoteParsed,
localParsed,
newValue,
_args2 = arguments;
return _regenerator().w(function (_context2) {
while (1) switch (_context2.n) {
case 0:
opts = _args2.length > 2 && _args2[2] !== undefined ? _args2[2] : {};
instance = _args2.length > 3 ? _args2[3] : undefined;
_formatArgs = formatArgs(storageKey, storageValue, opts, instance), key = _formatArgs.key, value = _formatArgs.value, resolve = _formatArgs.resolve, storage = _formatArgs.storage;
/*
console.log('key', key)
console.log('value', value)
console.log('resolve', resolve)
console.log('storageInstance', storageInstance)
/**/
/* No conflict resolver, set remote item */
if (resolve) {
_context2.n = 1;
break;
}
return _context2.a(2, setRemoteItemRaw(key, value, storage));
case 1:
_context2.n = 2;
return getRemoteItemRaw(key, storage);
case 2:
remoteValueRaw = _context2.v;
if (remoteValueRaw) {
_context2.n = 3;
break;
}
return _context2.a(2, setRemoteItemRaw(key, value, storage));
case 3:
/* Remote value found, parse it and run resolver function */
remoteParsed = safeParse(remoteValueRaw);
localParsed = safeParse(value);
_context2.n = 4;
return resolve({
key: key,
local: localParsed,
localRaw: value,
remote: remoteParsed,
remoteRaw: remoteValueRaw,
isEqual: value === remoteValueRaw || localParsed === remoteParsed
});
case 4:
newValue = _context2.v;
return _context2.a(2, setRemoteItemRaw(key, newValue, storage));
}
}, _callee2);
}));
return _setRemoteItem.apply(this, arguments);
}
function getRemoteItemRaw(key, instance) {
if (!typeUtils.isBrowser) return;
return instance.onConnect().then(function () {
return instance.get(key);
})
// Swallow errors. @TODO make option
["catch"](function (e) {});
}
/**
* Set value on remote storage
* @param {String} key - localStorage key
* @param {String} value - localStorage value
* @return {Promise}
*/
function setRemoteItemRaw(_x5, _x6, _x7) {
return _setRemoteItemRaw.apply(this, arguments);
}
function _setRemoteItemRaw() {
_setRemoteItemRaw = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee3(key, value, instance) {
return _regenerator().w(function (_context3) {
while (1) switch (_context3.n) {
case 0:
if (!(typeUtils.isUndefined(value) || !typeUtils.isBrowser)) {
_context3.n = 1;
break;
}
return _context3.a(2);
case 1:
return _context3.a(2, instance.onConnect().then(function () {
return instance.set(key, value);
})
// Swallow errors. @TODO make option
["catch"](function (e) {}));
}
}, _callee3);
}));
return _setRemoteItemRaw.apply(this, arguments);
}
function safeParse(val) {
if (typeUtils.isUndefined(val)) return;
try {
return JSON.parse(val);
} catch (e) {
return JSON.parse("\"".concat(val, "\""));
}
}
Object.defineProperty(exports, 'CrossStorageClient', {
enumerable: true,
get: function () { return crossStorage.CrossStorageClient; }
});
Object.defineProperty(exports, 'CrossStorageHub', {
enumerable: true,
get: function () { return crossStorage.CrossStorageHub; }
});
exports.RemoteStorage = RemoteStorage;
exports.getRemoteItem = getRemoteItem;
exports.getRemoteItemRaw = getRemoteItemRaw;
exports.setRemoteItem = setRemoteItem;
exports.setRemoteItemRaw = setRemoteItemRaw;