Add tooltip about chapters feature

This commit is contained in:
Ajay
2022-09-18 03:15:20 -04:00
parent 4804c7f439
commit 6d757857cb
6 changed files with 56 additions and 9 deletions

View File

@@ -1170,6 +1170,10 @@
"message": "Note: Permission to submit chapters is still based on calculated reputation. Purchasing a license only allows you to view chapters submitted by others", "message": "Note: Permission to submit chapters is still based on calculated reputation. Purchasing a license only allows you to view chapters submitted by others",
"description": "On the chapters page for getting access to the paid chapters feature" "description": "On the chapters page for getting access to the paid chapters feature"
}, },
"chapterNewFeature": {
"message": "New Feature: Crowd-sourced custom chapters. These are custom-named sections in videos that can be stacked to get more and more precise. Purchase a license to view the chapters submitted on this video such as: ",
"description": "After the comma, a list of chapters for this video will appear"
},
"unsubmittedSegmentCounts": { "unsubmittedSegmentCounts": {
"message": "You currently have {0} on {1}", "message": "You currently have {0} on {1}",
"description": "Example: You currently have 12 unsubmitted segments on 5 videos" "description": "Example: You currently have 12 unsubmitted segments on 5 videos"

View File

@@ -63,6 +63,9 @@ chrome.runtime.onMessage.addListener(function (request, sender, callback) {
case "openHelp": case "openHelp":
chrome.tabs.create({url: chrome.runtime.getURL('help/index.html')}); chrome.tabs.create({url: chrome.runtime.getURL('help/index.html')});
return; return;
case "openUpsell":
chrome.tabs.create({url: chrome.runtime.getURL('upsell/index.html')});
return;
case "openPage": case "openPage":
chrome.tabs.create({url: chrome.runtime.getURL(request.url)}); chrome.tabs.create({url: chrome.runtime.getURL(request.url)});
return; return;

View File

@@ -62,9 +62,9 @@ interface SBConfig {
}, },
scrollToEditTimeUpdate: boolean, scrollToEditTimeUpdate: boolean,
categoryPillUpdate: boolean, categoryPillUpdate: boolean,
showChapterInfoMessage: boolean,
darkMode: boolean, darkMode: boolean,
showCategoryGuidelines: boolean, showCategoryGuidelines: boolean,
chaptersAvailable: boolean,
showCategoryWithoutPermission: boolean, showCategoryWithoutPermission: boolean,
// Used to cache calculated text color info // Used to cache calculated text color info
@@ -193,9 +193,9 @@ const Config: SBObject = {
autoSkipOnMusicVideos: false, autoSkipOnMusicVideos: false,
scrollToEditTimeUpdate: false, // false means the tooltip will be shown scrollToEditTimeUpdate: false, // false means the tooltip will be shown
categoryPillUpdate: false, categoryPillUpdate: false,
showChapterInfoMessage: true,
darkMode: true, darkMode: true,
showCategoryGuidelines: true, showCategoryGuidelines: true,
chaptersAvailable: true,
showCategoryWithoutPermission: false, showCategoryWithoutPermission: false,
categoryPillColors: {}, categoryPillColors: {},

View File

@@ -37,6 +37,8 @@ import { logDebug } from "./utils/logger";
import { importTimes } from "./utils/exporter"; import { importTimes } from "./utils/exporter";
import { ChapterVote } from "./render/ChapterVote"; import { ChapterVote } from "./render/ChapterVote";
import { openWarningDialog } from "./utils/warnings"; import { openWarningDialog } from "./utils/warnings";
import { Tooltip } from "./render/Tooltip";
import { noRefreshFetchingChaptersAllowed } from "./utils/licenseKey";
const utils = new Utils(); const utils = new Utils();
@@ -941,8 +943,14 @@ async function sponsorsLookup(keepOldSubmissions = true) {
setupVideoMutationListener(); setupVideoMutationListener();
// Create categories list const showChapterMessage = Config.config.payments.lastCheck !== 0
&& !noRefreshFetchingChaptersAllowed()
&& Config.config.showChapterInfoMessage
&& Config.config.skipCount > 200
&& Math.random() > 0.8;
const categories: string[] = Config.config.categorySelections.map((category) => category.name); const categories: string[] = Config.config.categorySelections.map((category) => category.name);
if (showChapterMessage && !categories.includes("chapter")) categories.push("chapter");
const extraRequestData: Record<string, unknown> = {}; const extraRequestData: Record<string, unknown> = {};
const hashParams = getHashParams(); const hashParams = getHashParams();
@@ -951,7 +959,7 @@ async function sponsorsLookup(keepOldSubmissions = true) {
const hashPrefix = (await utils.getHash(sponsorVideoID, 1)).slice(0, 4) as VideoID & HashedValue; const hashPrefix = (await utils.getHash(sponsorVideoID, 1)).slice(0, 4) as VideoID & HashedValue;
const response = await utils.asyncRequestToServer('GET', "/api/skipSegments/" + hashPrefix, { const response = await utils.asyncRequestToServer('GET', "/api/skipSegments/" + hashPrefix, {
categories, categories,
actionTypes: getEnabledActionTypes(), actionTypes: getEnabledActionTypes(showChapterMessage),
userAgent: `${chrome.runtime.id}`, userAgent: `${chrome.runtime.id}`,
...extraRequestData ...extraRequestData
}); });
@@ -960,7 +968,7 @@ async function sponsorsLookup(keepOldSubmissions = true) {
lastResponseStatus = response?.status; lastResponseStatus = response?.status;
if (response?.ok) { if (response?.ok) {
const recievedSegments: SponsorTime[] = JSON.parse(response.responseText) let recievedSegments: SponsorTime[] = JSON.parse(response.responseText)
?.filter((video) => video.videoID === sponsorVideoID) ?.filter((video) => video.videoID === sponsorVideoID)
?.map((video) => video.segments)?.[0] ?.map((video) => video.segments)?.[0]
?.map((segment) => ({ ?.map((segment) => ({
@@ -974,6 +982,28 @@ async function sponsorsLookup(keepOldSubmissions = true) {
return; return;
} }
if (showChapterMessage) {
const chapterSegments = recievedSegments.filter((s) => s.actionType === ActionType.Chapter);
if (chapterSegments.length > 3) {
const prependElement = document.querySelector(".ytp-chrome-bottom") as HTMLElement;
if (prependElement) {
Config.config.showChapterInfoMessage = false;
new Tooltip({
text: `🟨${chrome.i18n.getMessage("chapterNewFeature")}${chapterSegments.slice(0, 3).map((s) => s.description).join(", ")}`,
linkOnClick: () => void chrome.runtime.sendMessage({ "message": "openUpsell" }),
referenceNode: prependElement.parentElement,
prependElement,
timeout: 1500,
leftOffset: "20px",
positionRealtive: false
});
}
}
recievedSegments = recievedSegments.filter((s) => s.actionType !== ActionType.Chapter);
}
sponsorDataFound = true; sponsorDataFound = true;
// Check if any old submissions should be kept // Check if any old submissions should be kept
@@ -1056,12 +1086,12 @@ function importExistingChapters(wait: boolean) {
} }
} }
function getEnabledActionTypes(): ActionType[] { function getEnabledActionTypes(forceFullVideo = false): ActionType[] {
const actionTypes = [ActionType.Skip, ActionType.Poi, ActionType.Chapter]; const actionTypes = [ActionType.Skip, ActionType.Poi, ActionType.Chapter];
if (Config.config.muteSegments) { if (Config.config.muteSegments) {
actionTypes.push(ActionType.Mute); actionTypes.push(ActionType.Mute);
} }
if (Config.config.fullVideoSegments) { if (Config.config.fullVideoSegments || forceFullVideo) {
actionTypes.push(ActionType.Full); actionTypes.push(ActionType.Full);
} }

View File

@@ -5,6 +5,7 @@ import { ButtonListener } from "../types";
export interface TooltipProps { export interface TooltipProps {
text?: string; text?: string;
link?: string; link?: string;
linkOnClick?: () => void;
referenceNode: HTMLElement; referenceNode: HTMLElement;
prependElement?: HTMLElement; // Element to append before prependElement?: HTMLElement; // Element to append before
bottomOffset?: string; bottomOffset?: string;
@@ -16,6 +17,7 @@ export interface TooltipProps {
extraClass?: string; extraClass?: string;
showLogo?: boolean; showLogo?: boolean;
showGotIt?: boolean; showGotIt?: boolean;
positionRealtive?: boolean;
buttons?: ButtonListener[]; buttons?: ButtonListener[];
} }
@@ -34,11 +36,12 @@ export class Tooltip {
props.extraClass ??= ""; props.extraClass ??= "";
props.showLogo ??= true; props.showLogo ??= true;
props.showGotIt ??= true; props.showGotIt ??= true;
props.positionRealtive ??= true;
this.text = props.text; this.text = props.text;
this.container = document.createElement('div'); this.container = document.createElement('div');
this.container.id = "sponsorTooltip" + props.text; this.container.id = "sponsorTooltip" + props.text;
this.container.style.position = "relative"; if (props.positionRealtive) this.container.style.position = "relative";
if (props.prependElement) { if (props.prependElement) {
props.referenceNode.insertBefore(this.container, props.prependElement); props.referenceNode.insertBefore(this.container, props.prependElement);
@@ -71,7 +74,12 @@ export class Tooltip {
href={props.link}> href={props.link}>
{chrome.i18n.getMessage("LearnMore")} {chrome.i18n.getMessage("LearnMore")}
</a> </a>
: null} : (props.linkOnClick ?
<a style={{textDecoration: "underline", marginLeft: "5px", cursor: "pointer"}}
onClick={props.linkOnClick}>
{chrome.i18n.getMessage("LearnMore")}
</a>
: null)}
</span> </span>
: null} : null}

View File

@@ -12,6 +12,7 @@ export async function checkLicenseKey(licenseKey: string): Promise<boolean> {
try { try {
if (result.ok && JSON.parse(result.responseText).allowed) { if (result.ok && JSON.parse(result.responseText).allowed) {
Config.config.payments.chaptersAllowed = true; Config.config.payments.chaptersAllowed = true;
Config.config.showChapterInfoMessage = false;
Config.config.payments.lastCheck = Date.now(); Config.config.payments.lastCheck = Date.now();
Config.forceSyncUpdate("payments"); Config.forceSyncUpdate("payments");
@@ -60,6 +61,7 @@ export async function fetchingChaptersAllowed(): Promise<boolean> {
if (userInfo.freeChaptersAccess) { if (userInfo.freeChaptersAccess) {
Config.config.payments.freeAccess = true; Config.config.payments.freeAccess = true;
Config.config.payments.chaptersAllowed = true; Config.config.payments.chaptersAllowed = true;
Config.config.showChapterInfoMessage = false;
Config.forceSyncUpdate("payments"); Config.forceSyncUpdate("payments");
return true; return true;