pagerts 0.2.0 → 1.0.1

package/src/page/PageFetcher.ts

@@ -1,30 +0,0 @@
-import { JSDOM, VirtualConsole } from 'jsdom';
-import type { Page, PageMetadata } from './Page';
-
-interface PageResponse {
-    url: string;
-    content?: JSDOM;
-    error?: string;
-}
-
-export class PageFetcher {
-    private async fetchPage(url: string): Promise<PageResponse> {
-        let dom: Promise<JSDOM>;
-        const virtualConsole = new VirtualConsole().on('jsdomError', (error) => {
-            process.stderr.write(`Error parsing ${url}:${error.message}\n`);
-        });
-        if (url.startsWith("file://")) {
-            dom = JSDOM.fromFile(url, { virtualConsole });
-        } else {
-            dom = JSDOM.fromURL(url, { virtualConsole });
-        }
-
-        return dom.then(content => ({ url, content }))
-            .catch(({ message }) => ({ url, error: `JSDOM failed to parse: ${message}` }));
-    }
-    async fetchAll(urls: string[]): Promise<PageResponse[]> {
-        const responses = await Promise.all(urls.map(url => this.fetchPage(url)));
-        return responses.filter(response => response.content !== undefined);
-    }
-
-}

package/src/printers/AbstractResourcePrinter.ts

@@ -1,6 +0,0 @@
-import type { Page, PageMetadata  } from "../page/Page";
-
-export abstract class AbstractResourcePrinter {
-    constructor() {  }
-    abstract print(...pages: PageMetadata[]): void | Promise<void>;
-}

package/src/printers/JSONStylePrinter.ts

@@ -1,12 +0,0 @@
-import type { PageMetadata } from "../page/Page";
-import { AbstractResourcePrinter } from "./AbstractResourcePrinter";
-
-
-export class JSONStylePrinter extends AbstractResourcePrinter {
-    print(...pages: PageMetadata[]): void | Promise<void> {
-        const json = JSON.stringify(pages);
-        process.stdout.write(json + "\n")
-    }
-   
-
-}

package/src/printers/LogStylePrinter.ts

@@ -1,28 +0,0 @@
-import { isPage, type Page, type PageMetadata } from '../page/Page';
-import { AbstractResourcePrinter } from './AbstractResourcePrinter';
-
-export class LogStylePrinter extends AbstractResourcePrinter {
-
-    write(str: string): void {
-        process.stdout.write(str)
-    }
-
-    async print(...pages: PageMetadata[]): Promise<void> {
-        for (const page of pages) {
-            if (!isPage(page)) {
-                this.write(page.error)
-                continue
-            }
-
-            const {resources, title, url } = page
-
-            this.write(`Title: ${title}\n`)
-            this.write(`URL: ${url}\n\n`)
-
-            for (const resource of resources) {
-                const { link: { url }, text: { value } } = resource
-                this.write(`${value}: ${url}\n`)
-            }
-        }
-    }
-}

package/src/resource.ts

@@ -1,96 +0,0 @@
-/**
- * @license MIT
- * We are interested in visualising a page as a collection of tags.
- * 
- * We wish to work with tags that can be compactly previewed on a webpage.
- * Here we must declare all of the element types that can be used to represent
- * a resource that can be hyperlinked off a webpage.
- */
-
-type Tags = HTMLElementTagNameMap
-
-function findDefinedKey(element: Resource, keys: LinkKey[]): LinkKey | undefined {
-    for (const key of keys) {
-        if (isKeyDefined(key, element)) {
-            return key;
-        }
-    }
-}
-
-export const RESOURCE_DISPLAYABLE_KEYS = [
-    'id',
-    'innerText',
-    'textContent',
-    'class',
-    'ariaLabel',
-    'ariaDescription',
-    'alt',
-    'rel'
-] as const;
-
-export type DisplayableKey = (typeof RESOURCE_DISPLAYABLE_KEYS)[number];
-
-export type ResourceKey = {
-    key: DisplayableKey;
-    value: string;
-};
-
-export const RESOURCE_LINK_KEYS = [
-    "href",
-    "data-src",
-    "target",
-    "action",
-    "src",
-    "url"
-] as const;
-
-export type LinkKey = typeof RESOURCE_LINK_KEYS[number];
-
-export type ResourceLink = {
-    key: LinkKey;
-    url: string;
-}
-
-export function findResourceText(element: Resource): ResourceKey | undefined {
-    for (const key of RESOURCE_DISPLAYABLE_KEYS) {
-        const value = element[key]
-        if (value && typeof value === 'string' && value.trim() !== '')
-            return { key, value };
-    }
-}
-
-export function findResourceLink(element: Resource): ResourceLink | undefined {
-    const key = findDefinedKey(element, [...RESOURCE_LINK_KEYS]);
-    const url = element[key];
-    if (url && typeof url === 'string' && url.trim() !== '')
-        return { key, url };
-}
-
-export type ExternalResource = {
-    text: ResourceKey;
-    link: ResourceLink;
-};
-
-export const isResourceKey = (key: string): key is LinkKey => key in RESOURCE_LINK_KEYS;
-
-export const isKeyDefined = <E extends Tags[keyof Tags]>(key: string, element: E): boolean =>
-    key in element && element[key] !== undefined;
-
-export type ResourceElement<T, U> = {
-    [K in keyof T]: U extends keyof T[K] ? T[K] : never
-}[keyof T];
-
-export type Tag = keyof Tags
-
-export type Resource = ResourceElement<Tags, (typeof RESOURCE_LINK_KEYS)[number]>;
-
-export type ResourceByName<T extends keyof Tags> = Tags[T]
-
-/** tests **/
-
-type test1 = HTMLAnchorElement extends Resource ? true : false // true
-type test2 = HTMLImageElement extends Resource ? true : false // true
-type test3 = HTMLDivElement extends Resource ? true : false // false
-
-type test4 = ResourceElement<Tags, "src">
-

package/tsconfig.json

@@ -1,12 +0,0 @@
-{
-    "compilerOptions": {
-        "module": "NodeNext",
-        "target": "ESNext",
-        "resolveJsonModule": true,
-        "outDir": "bin",
-        "sourceMap": true,
-    },
-    "include": [
-        "src/**.*",
-    ],
-}