lightnovelwp: improvements, new source katreadingarchive.me

- generator now supports custom runtime JS and CSS, property names changed to clarify the difference
- fixed some type errors
- attempt to make "hide locked" option work

Author: ilonachan

plugins/multisrc/lightnovelwp/generator.js

@@ -5,6 +5,10 @@ import { dirname, join } from 'path';
 
 const folder = dirname(fileURLToPath(import.meta.url));
 
+const LightNovelWPTemplate = readFileSync(join(folder, 'template.ts'), {
+  encoding: 'utf-8',
+});
+
 export const generateAll = function () {
   return list.map(source => {
     const exist = existsSync(join(folder, 'filters', source.id + '.json'));
@@ -15,21 +19,18 @@ export const generateAll = function () {
       source.filters = JSON.parse(filters).filters;
     }
     console.log(
-      `[lightnovelwp] Generating: ${source.id}${' '.repeat(20 - source.id.length)} ${source.filters ? '🔎with filters🔍' : '🚫no filters🚫'}`,
+      `[lightnovelwp] Generating: ${source.id} ${' '.repeat(20 - source.id.length)} ${source.filters ? '🔎with filters🔍' : '🚫no filters🚫'}`,
     );
     return generator(source);
   });
 };
 
 const generator = function generator(source) {
-  const LightNovelWPTemplate = readFileSync(join(folder, 'template.ts'), {
-    encoding: 'utf-8',
-  });
 
   const pluginScript = `
 ${LightNovelWPTemplate.replace(
   '// CustomJS HERE',
-  source.options?.customJs || '',
+  source.options?.customTransformJs || '',
 )}
 const plugin = new LightNovelWPPlugin(${JSON.stringify(source)});
 export default plugin;

plugins/multisrc/lightnovelwp/sources.json

@@ -15,7 +15,7 @@
     "options": {
       "lang": "Arabic",
       "reverseChapters": true,
-      "customJs": "$('article > style').text().match(/\\.\\w+(?=\\s*[,{])/g)?.forEach(tag => $(`p${tag}`).remove());$('.epcontent .code-block').remove();",
+      "customTransformJs": "$('article > style').text().match(/\\.\\w+(?=\\s*[,{])/g)?.forEach(tag => $(`p${tag}`).remove());$('.epcontent .code-block').remove();",
       "versionIncrements": 9
     }
   },
@@ -107,7 +107,7 @@
       "lang": "English",
       "reverseChapters": true,
       "versionIncrements": 2,
-      "customJs": "$('.announ').remove();         return $('.epcontent').eq(-1).find('p').map(function (i, el) {          return '<p>' + $(this).text() + '</p>';        }).toArray().join('\\n') || '';"
+      "customTransformJs": "$('.announ').remove();         return $('.epcontent').eq(-1).find('p').map(function (i, el) {          return '<p>' + $(this).text() + '</p>';        }).toArray().join('\\n') || '';"
     }
   },
   {
@@ -199,7 +199,7 @@
     "options": {
       "lang": "English",
       "reverseChapters": true,
-      "customJs": "\n        $('div.entry-content script').remove();\n\n        const url = this.site + chapterPath.slice(0, -1);\n        const offsets = [[0, 12368, 12462], [1, 6960, 7054], [2, 4176, 4270]];\n        const idx = url.length * url.charCodeAt(url.length - 1) * 2 % 3;\n        const [_, offsetLower, offsetCap] = offsets[idx] ?? offsets[0];\n\n        const asciiA = 'A'.charCodeAt(0);\n        const asciiz = 'z'.charCodeAt(0);\n\n        $('div.entry-content > p').text((_, txt) =>\n            txt.split('').map(char => {\n                const code = char.charCodeAt(0);\n                const offset = (code >= offsetLower + asciiA && code <= offsetLower + asciiz)\n                    ? offsetLower\n                    : offsetCap;\n                const decoded = code - offset;\n                return (decoded >= 32 && decoded <= 126) ? String.fromCharCode(decoded) : char;\n            }).join('')\n        );\n",
+      "customTransformJs": "\n        $('div.entry-content script').remove();\n\n        const url = this.site + chapterPath.slice(0, -1);\n        const offsets = [[0, 12368, 12462], [1, 6960, 7054], [2, 4176, 4270]];\n        const idx = url.length * url.charCodeAt(url.length - 1) * 2 % 3;\n        const [_, offsetLower, offsetCap] = offsets[idx] ?? offsets[0];\n\n        const asciiA = 'A'.charCodeAt(0);\n        const asciiz = 'z'.charCodeAt(0);\n\n        $('div.entry-content > p').text((_, txt) =>\n            txt.split('').map(char => {\n                const code = char.charCodeAt(0);\n                const offset = (code >= offsetLower + asciiA && code <= offsetLower + asciiz)\n                    ? offsetLower\n                    : offsetCap;\n                const decoded = code - offset;\n                return (decoded >= 32 && decoded <= 126) ? String.fromCharCode(decoded) : char;\n            }).join('')\n        );\n",
       "versionIncrements": 4
     }
   },
@@ -284,5 +284,19 @@
       "lang": "English",
       "reverseChapters": true
     }
+  },
+  {
+    "id": "katreadingarchive",
+    "sourceSite": "https://katreadingarchive.me",
+    "sourceName": "Kat Reading Archive",
+    "options": {
+      "lang": "English",
+      "versionIncrements": 1,
+      "reverseChapters": true,
+      "hasLocked": true,
+      "customTransformJs": "$('div.epcontent > span:first-of-type').remove(); $('.ckb-wrap').remove();",
+      "customRuntimeJs": "multisrc/lightnovelwp/katreadingarchive/customJs.js",
+      "customCss": "multisrc/lightnovelwp/katreadingarchive/customCss.css"
+    }
   }
 ]

plugins/multisrc/lightnovelwp/template.ts

@@ -12,8 +12,10 @@ type LightNovelWPOptions = {
   lang?: string;
   versionIncrements?: number;
   seriesPath?: string;
-  customJs?: string;
+  customTransformJs?: string;
   hasLocked?: boolean;
+  customRuntimeJs?: string;
+  customCss?: string;
 };
 
 export type LightNovelWPMetadata = {
@@ -32,7 +34,10 @@ class LightNovelWPPlugin implements Plugin.PluginBase {
   version: string;
   options?: LightNovelWPOptions;
   filters?: Filters;
+  customJS?: string;
+  customCSS?: string;
 
+  // TODO: this probably needs to be done at use time, otherwise changes won't be reflected
   hideLocked = storage.get('hideLocked');
   pluginSettings?: Record<string, any>;
 
@@ -42,9 +47,11 @@ class LightNovelWPPlugin implements Plugin.PluginBase {
     this.icon = `multisrc/lightnovelwp/${metadata.id.toLowerCase()}/icon.png`;
     this.site = metadata.sourceSite;
     const versionIncrements = metadata.options?.versionIncrements || 0;
-    this.version = `1.1.${9 + versionIncrements}`;
+    this.version = `1.1.${10 + versionIncrements}`;
     this.options = metadata.options ?? ({} as LightNovelWPOptions);
     this.filters = metadata.filters satisfies Filters;
+    this.customJS = this.options.customRuntimeJs;
+    this.customCSS = this.options.customCss;
 
     if (this.options?.hasLocked) {
       this.pluginSettings = {
@@ -64,7 +71,7 @@ class LightNovelWPPlugin implements Plugin.PluginBase {
     return url_parts.join('.');
   }
 
-  async safeFecth(url: string, search: boolean): Promise<string> {
+  async safeFetch(url: string, search: boolean): Promise<string> {
     const urlParts = url.split('://');
     const protocol = urlParts.shift();
     const sanitizedUri = urlParts[0].replace(/\/\//g, '/');
@@ -147,13 +154,13 @@ class LightNovelWPPlugin implements Plugin.PluginBase {
           url += `&${key}=${value}`;
       else if (filters[key].value) url += `&${key}=${filters[key].value}`;
     }
-    const html = await this.safeFecth(url, false);
+    const html = await this.safeFetch(url, false);
     return this.parseNovels(html);
   }
 
   async parseNovel(novelPath: string): Promise<Plugin.SourceNovel> {
     const baseURL = this.site;
-    const html = await this.safeFecth(baseURL + novelPath, false);
+    const html = await this.safeFetch(baseURL + novelPath, false);
 
     const novel: Plugin.SourceNovel = {
       path: novelPath,
@@ -180,7 +187,10 @@ class LightNovelWPPlugin implements Plugin.PluginBase {
     let hasLockItemOnChapterNum = false;
     const chapters: Plugin.ChapterItem[] = [];
     let tempChapter = {} as Plugin.ChapterItem;
-    const hideLocked = this.hideLocked;
+
+    const hideLocked = !!(
+      storage.get('hideLocked') ?? this.pluginSettings?.['hideLocked'].value
+    );
 
     const parser = new Parser({
       onopentag(name, attribs) {
@@ -421,29 +431,28 @@ class LightNovelWPPlugin implements Plugin.PluginBase {
       novel.chapters = chapters;
     }
 
-    novel.summary = novel.summary.trim();
+    novel.summary = novel.summary?.trim();
 
     return novel;
   }
 
   async parseChapter(chapterPath: string): Promise<string> {
-    let data = await this.safeFecth(this.site + chapterPath, false);
-    if (this.options?.customJs) {
+    let data = await this.safeFetch(this.site + chapterPath, false);
+    const $ = load(data);
+    if (this.options?.customTransformJs) {
       try {
-        const $ = load(data);
         // CustomJS HERE
-        data = $.html();
       } catch (error) {
         console.error('Error executing customJs:', error);
         throw error;
       }
     }
-    return (
-      data
-        .match(/<div.*?class="epcontent ([^]*?)<div.*?class="?bottomnav/g)?.[0]
-        .match(/<p[^>]*>([^]*?)<\/p>/g)
-        ?.join('\n') || ''
-    );
+    const content = $('div.epcontent');
+    // content.find('h1:first-child').remove();
+
+    // content.find('> :not(p)').remove();
+
+    return content.html() ?? '';
   }
 
   async searchNovels(
@@ -452,7 +461,7 @@ class LightNovelWPPlugin implements Plugin.PluginBase {
   ): Promise<Plugin.NovelItem[]> {
     const url =
       this.site + 'page/' + page + '/?s=' + encodeURIComponent(searchTerm);
-    const html = await this.safeFecth(url, true);
+    const html = await this.safeFetch(url, true);
     return this.parseNovels(html);
   }
 }

public/static/multisrc/lightnovelwp/katreadingarchive/customCss.css

@@ -0,0 +1,7 @@
+blockquote, q {
+  padding: 5px 10px;
+  background-color: var(--theme-surfaceVariant);
+  color: var(--theme-onSurfaceVariant);
+  border-left: 4px solid var(--theme-outline);
+  quotes: none;
+}

public/static/multisrc/lightnovelwp/katreadingarchive/customJs.js

@@ -0,0 +1 @@
+// WORKAROUND: empty files currently break the download function!