SponsorBlock/src/SB.ts

224 lines
5.2 KiB
TypeScript
Raw Normal View History

2020-01-29 04:16:48 +01:00
interface SBObject {
configListeners: Array<Function>;
defaults: any;
localConfig: any;
config: any;
}
// Allows a SBMap to be conveted into json form
// Currently used for local storage
class SBMap<T, U> extends Map {
toJSON() {
return Array.from(this.entries());
}
}
// TODO: Rename to something more meaningful
var SB: SBObject = {
2020-01-10 02:09:32 +01:00
/**
* Callback function when an option is updated
*/
2020-01-29 04:16:48 +01:00
configListeners: [],
defaults: {
"sponsorTimes": new SBMap(),
"startSponsorKeybind": ";",
"submitKeybind": "'",
"minutesSaved": 0,
"skipCount": 0,
"sponsorTimesContributed": 0,
"disableSkipping": false,
"disableAutoSkip": false,
"trackViewCount": true,
"dontShowNotice": false,
"hideVideoPlayerControls": false,
"hideInfoButtonPlayerControls": false,
"hideDeleteButtonPlayerControls": false,
"hideDiscordLaunches": 0,
"hideDiscordLink": false,
"invidiousInstances": ["invidio.us", "invidiou.sh", "invidious.snopyta.org"],
"invidiousUpdateInfoShowCount": 0,
"autoUpvote": true
},
localConfig: {},
config: {}
2020-01-10 02:09:32 +01:00
};
2019-12-31 21:07:43 +01:00
2020-01-09 18:46:04 +01:00
// Function setup
2020-01-16 19:43:49 +01:00
// Proxy Map changes to Map in SB.localConfig
// Saves the changes to chrome.storage in json form
class MapIO {
2020-01-29 04:16:48 +01:00
id: string;
SBMap: SBMap<String, any>;
2020-01-09 17:39:23 +01:00
constructor(id) {
2020-01-29 04:16:48 +01:00
// The name of the item in the array
2020-01-16 18:57:54 +01:00
this.id = id;
2020-01-29 04:16:48 +01:00
// A local copy of the SBMap (SB.config.SBMapname.SBMap)
this.SBMap = SB.localConfig[this.id];
2020-01-09 00:16:02 +01:00
}
2020-01-29 04:16:48 +01:00
2020-01-09 00:16:02 +01:00
set(key, value) {
2020-01-29 04:16:48 +01:00
// Proxy to SBMap
this.SBMap.set(key, value);
// Store updated SBMap locally
2020-01-16 15:29:03 +01:00
chrome.storage.sync.set({
2020-01-29 04:16:48 +01:00
[this.id]: encodeStoredItem(this.SBMap)
2020-01-16 15:29:03 +01:00
});
2020-01-29 04:16:48 +01:00
return this.SBMap;
2020-01-09 00:16:02 +01:00
}
2020-01-16 18:57:54 +01:00
get(key) {
2020-01-29 04:16:48 +01:00
return this.SBMap.get(key);
2020-01-16 18:57:54 +01:00
}
2020-01-09 17:39:23 +01:00
has(key) {
2020-01-29 04:16:48 +01:00
return this.SBMap.has(key);
2020-01-09 00:16:02 +01:00
}
2020-01-09 17:39:23 +01:00
size() {
2020-01-29 04:16:48 +01:00
return this.SBMap.size;
2020-01-09 00:16:02 +01:00
}
2020-01-09 17:39:23 +01:00
delete(key) {
2020-01-29 04:16:48 +01:00
// Proxy to SBMap
this.SBMap.delete(key);
// Store updated SBMap locally
chrome.storage.sync.set({
[this.id]: encodeStoredItem(this.SBMap)
2020-01-16 18:57:54 +01:00
});
2020-01-09 00:16:02 +01:00
}
2020-01-16 19:02:48 +01:00
2020-01-16 19:27:29 +01:00
clear() {
2020-01-29 04:16:48 +01:00
this.SBMap.clear();
chrome.storage.sync.set({
[this.id]: encodeStoredItem(this.SBMap)
2020-01-16 19:03:40 +01:00
});
2020-01-16 19:02:48 +01:00
}
2020-01-09 18:12:49 +01:00
}
2020-01-09 18:46:04 +01:00
/**
2020-01-29 04:16:48 +01:00
* A SBMap cannot be stored in the chrome storage.
2020-01-09 18:46:04 +01:00
* This data will be encoded into an array instead as specified by the toJSON function.
*
* @param {*} data
*/
function encodeStoredItem(data) {
2020-01-29 04:16:48 +01:00
// if data is SBMap convert to json for storing
if(!(data instanceof SBMap)) return data;
2020-01-16 19:27:29 +01:00
return JSON.stringify(data);
2020-01-09 18:12:49 +01:00
}
/**
2020-01-29 04:16:48 +01:00
* A SBMap cannot be stored in the chrome storage.
* This data will be decoded from the array it is stored in
*
* @param {*} data
*/
function decodeStoredItem(data) {
2020-01-09 18:30:09 +01:00
if(typeof data !== "string") return data;
try {
let str = JSON.parse(data);
2020-01-11 20:48:17 +01:00
if(!Array.isArray(str)) return data;
2020-01-29 04:16:48 +01:00
return new SBMap(str);
2020-01-09 18:12:49 +01:00
} catch(e) {
// If all else fails, return the data
return data;
}
2020-01-09 00:16:02 +01:00
}
2020-01-29 04:16:48 +01:00
function configProxy(): void {
2019-12-31 21:07:43 +01:00
chrome.storage.onChanged.addListener((changes, namespace) => {
2020-01-10 02:09:32 +01:00
for (const key in changes) {
2020-01-09 19:17:26 +01:00
SB.localConfig[key] = decodeStoredItem(changes[key].newValue);
2019-12-31 21:07:43 +01:00
}
2020-01-10 02:09:32 +01:00
for (const callback of SB.configListeners) {
callback(changes);
}
2019-12-31 21:07:43 +01:00
});
2020-01-09 17:39:23 +01:00
2020-01-29 04:16:48 +01:00
var handler: ProxyHandler<any> = {
set(obj, prop, value) {
2020-01-09 19:17:26 +01:00
SB.localConfig[prop] = value;
2020-01-09 19:16:27 +01:00
2019-12-31 21:07:43 +01:00
chrome.storage.sync.set({
2020-01-09 18:46:04 +01:00
[prop]: encodeStoredItem(value)
2020-01-08 04:59:50 +01:00
});
2020-01-29 04:16:48 +01:00
return true;
2019-12-31 21:07:43 +01:00
},
2020-01-29 04:16:48 +01:00
get(obj, prop): any {
2020-01-09 19:17:26 +01:00
let data = SB.localConfig[prop];
2020-01-29 04:16:48 +01:00
if(data instanceof SBMap) data = new MapIO(prop);
return obj[prop] || data;
},
deleteProperty(obj, prop) {
2020-01-29 04:16:48 +01:00
chrome.storage.sync.remove(<string> prop);
return true;
2019-12-31 21:07:43 +01:00
}
2020-01-16 19:43:49 +01:00
2019-12-31 21:07:43 +01:00
};
2020-01-08 04:59:50 +01:00
2020-01-09 18:30:09 +01:00
return new Proxy({handler}, handler);
2019-12-31 21:07:43 +01:00
}
2020-01-09 18:46:04 +01:00
function fetchConfig() {
return new Promise((resolve, reject) => {
chrome.storage.sync.get(null, function(items) {
2020-01-09 19:17:26 +01:00
SB.localConfig = items; // Data is ready
2020-01-09 18:46:04 +01:00
resolve();
});
2019-12-31 21:07:43 +01:00
});
2020-01-09 18:46:04 +01:00
}
2019-12-31 21:07:43 +01:00
2020-01-09 18:46:04 +01:00
function migrateOldFormats() { // Convert sponsorTimes format
2020-01-11 20:50:11 +01:00
for (const key in SB.localConfig) {
2020-01-07 00:12:48 +01:00
if (key.startsWith("sponsorTimes") && key !== "sponsorTimes" && key !== "sponsorTimesContributed") {
2020-01-06 22:17:28 +01:00
SB.config.sponsorTimes.set(key.substr(12), SB.config[key]);
delete SB.config[key];
2020-01-06 22:11:37 +01:00
}
}
}
2020-01-09 18:46:04 +01:00
async function setupConfig() {
2019-12-31 21:07:43 +01:00
await fetchConfig();
addDefaults();
convertJSON();
SB.config = configProxy();
2020-01-09 18:46:04 +01:00
migrateOldFormats();
2019-12-31 21:07:43 +01:00
}
2019-12-31 23:46:16 +01:00
// Reset config
function resetConfig() {
SB.config = SB.defaults;
2019-12-31 23:46:16 +01:00
};
2020-01-09 18:46:04 +01:00
function convertJSON() {
Object.keys(SB.defaults).forEach(key => {
SB.localConfig[key] = decodeStoredItem(SB.localConfig[key], key);
});
2020-01-09 17:39:23 +01:00
}
2020-01-09 18:46:04 +01:00
2019-12-31 23:46:16 +01:00
// Add defaults
function addDefaults() {
for (const key in SB.defaults) {
if(!SB.localConfig.hasOwnProperty(key)) {
SB.localConfig[key] = SB.defaults[key];
}
}
2019-12-31 23:46:16 +01:00
};
2019-12-31 21:07:43 +01:00
// Sync config
2020-01-09 18:46:04 +01:00
setupConfig();
2020-01-29 04:16:48 +01:00
export default SB;