document-ir 0.0.6

package/esm/types.d.ts

@@ -0,0 +1,307 @@
+export interface ArrayNode {
+    type: "array";
+    content: Node[];
+}
+export interface BlockNode {
+    type: "block";
+    content: Node[];
+}
+export interface BlockQuoteNode {
+    type: "block-quote";
+    content: Node[];
+}
+export interface BoldNode {
+    type: "bold";
+    content: Node[];
+}
+export interface BreakNode {
+    type: "break";
+}
+export interface BubbleNode {
+    type: "bubble";
+    orientation: "left" | "right";
+    content: Node[];
+}
+export interface CenterNode {
+    type: "center";
+    content: Node[];
+}
+export interface CodeNode {
+    type: "code";
+    content: Node[];
+}
+export interface ColumnsNode {
+    type: "columns";
+    "column-count": 1 | 2 | 3 | 4;
+    columns: Node[][];
+}
+export interface DefinitionNode {
+    type: "definition";
+    content: Node[];
+    title: Node[];
+    abbreviation: Node[];
+    key: string;
+}
+export interface DefinitionListNode {
+    type: "definition-list";
+    content: DefinitionNode[];
+}
+export interface DefinitionReferenceNode {
+    type: "definition-reference";
+    definition: {
+        abbreviation: Node[];
+        key: string;
+    };
+    content: Node[];
+}
+export interface EmbedImagePreview {
+    url: string;
+    blurhash: string;
+    width: number;
+    height: number;
+}
+export interface YoutubeEmbed {
+    type: "youtube";
+    id: string;
+    imagePreview?: EmbedImagePreview;
+}
+export interface EmbedNode {
+    type: "embed";
+    content: YoutubeEmbed;
+}
+export interface EmojiNode {
+    type: "emoji";
+    url: string;
+    alt: string;
+}
+export interface FigureNode {
+    type: "figure";
+    content: Node[];
+}
+export interface FigureCaptionNode {
+    type: "figure-caption";
+    content: Node[];
+}
+export interface FigureImageNode {
+    type: "figure-image";
+    content: Node[];
+    width: number;
+    height: number;
+    blurhash?: string;
+    url: string;
+    image?: string;
+    alt: string;
+    hero?: true;
+}
+export interface FormattedTextNode {
+    type: "formatted-text";
+    language?: string;
+    text: string;
+}
+export interface HeaderNode {
+    type: "header";
+    level: 1 | 2 | 3 | 4 | 5 | 6;
+    content: Node[];
+}
+export interface HighTechAlertNode {
+    type: "high-tech-alert";
+    content: Node[];
+    warning: Node[];
+}
+export interface HorizontalRuleNode {
+    type: "horizontal-rule";
+}
+export interface ImageNode {
+    type: "image";
+    url: string;
+    alt: string;
+    width?: number;
+    height?: number;
+    blurhash?: string;
+    image?: string;
+    hero?: true;
+}
+export interface ItalicNode {
+    type: "italic";
+    content: Node[];
+}
+export interface LinkNode {
+    type: "link";
+    content: Node[];
+    url: string;
+    title?: string;
+    target?: "_blank" | "_self" | "_top";
+    userGeneratedContent?: true;
+    noReferrer?: true;
+    noFollow?: true;
+    noOpener?: true;
+}
+export interface ListNode {
+    type: "list";
+    style: "ordered" | "unordered";
+    content: ListItem[];
+}
+export interface ListItem {
+    type: "list-item";
+    content: Node[];
+}
+export interface NoteNode {
+    type: "note";
+    content: Node[];
+}
+export interface ParagraphNode {
+    type: "paragraph";
+    content: Node[];
+}
+export interface QuoteNode {
+    type: "quote";
+    name: string;
+    icon: string;
+    url?: string;
+    orientation?: "left" | "right";
+    content: Node[];
+}
+export interface RedactedNode {
+    type: "redacted";
+    style: "inline" | "block";
+    content: Node[];
+}
+export interface RegionNode {
+    type: "region";
+    mode: "deny" | "allow";
+    content: Node[];
+    regions: string;
+}
+export interface ScriptNode {
+    type: "script";
+    "mime-type": string;
+    source: string;
+}
+export interface SecretNode {
+    type: "secret";
+    content: Node[];
+}
+export interface SmallerNode {
+    type: "smaller";
+    content: Node[];
+}
+export interface StrikeThroughNode {
+    type: "strike-through";
+    content: Node[];
+}
+export interface StickerNode {
+    type: "sticker";
+    size?: number;
+    orientation: "center" | "left" | "right";
+    character: string;
+    content: Node[];
+    name: string;
+}
+export interface TableNode {
+    type: "table";
+    content: TableCellNode[][];
+}
+export interface TableCellNode {
+    type: "table-cell";
+    header?: true;
+    span: [number, number];
+    content: Node[];
+}
+export interface TextNode {
+    type: "text";
+    text: string;
+}
+export interface UnderlineNode {
+    type: "underline";
+    content: Node[];
+}
+export interface VideoNode {
+    type: "video";
+    poster: string;
+    alt: string;
+    mp4: string;
+    width?: number;
+    webm?: string;
+    blurhash?: string;
+    height?: number;
+    muted?: true;
+    autoplay?: true;
+    loop?: true;
+    content?: Node[];
+}
+export interface WarningNode {
+    type: "warning";
+    content: Node[];
+}
+export interface TweetNode {
+    type: "tweet";
+    id: string;
+}
+export interface TootNode {
+    type: "toot";
+    id: string;
+}
+export interface VimeoNode {
+    type: "vimeo";
+    id: string;
+}
+export interface YoutubeNode {
+    type: "youtube";
+    id: string;
+}
+export type SocialNode = TweetNode | TootNode | VimeoNode | YoutubeNode;
+export interface CardHeader {
+    type: "card-header";
+    imageUrl?: string;
+    imageBlurhash?: string;
+    backgroundImage?: string;
+    backgroundColor?: string;
+    backgroundBlurhash?: string;
+    title: Node[];
+    url?: string;
+    username?: string;
+    usernameDomain?: string;
+}
+export interface CardMedia {
+    type: "card-media";
+    content: (ImageNode | VideoNode | EmbedNode)[];
+}
+export interface CardAttribution {
+    type: "card-attribution";
+    title?: Node[];
+    url?: string;
+    date?: string;
+    archiveUrl?: string;
+}
+export interface CardContent {
+    type: "card-content";
+    content: Node[];
+}
+export type CardContentNode = CardHeader | CardContent | CardMedia | CardAttribution;
+export interface CardNode {
+    type: "card";
+    header?: CardHeader;
+    content?: CardContent;
+    media?: CardMedia;
+    attribution?: CardAttribution;
+    original?: Node;
+}
+export type Node = ArrayNode | BlockNode | BlockQuoteNode | BoldNode | BreakNode | BubbleNode | CardNode | CenterNode | CodeNode | ColumnsNode | DefinitionNode | DefinitionListNode | DefinitionReferenceNode | EmbedNode | EmojiNode | FigureNode | FigureCaptionNode | FigureImageNode | FormattedTextNode | HeaderNode | HighTechAlertNode | HorizontalRuleNode | ImageNode | ItalicNode | LinkNode | ListNode | NoteNode | ParagraphNode | QuoteNode | RedactedNode | RegionNode | ScriptNode | SecretNode | SmallerNode | StickerNode | StrikeThroughNode | TextNode | TableNode | SocialNode | UnderlineNode | VideoNode | WarningNode;
+export interface DocumentMeta {
+    hidden?: boolean;
+    noindex?: boolean;
+    title: string;
+    author?: string;
+    description?: string;
+    image?: string;
+    guid?: string;
+    "pub-date"?: number;
+    date?: string;
+    url: string;
+    contentDigest?: string;
+}
+export interface DocumentNode extends DocumentMeta {
+    type: "document";
+    content: Node[];
+    definitions?: DefinitionNode[];
+}

package/esm/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,29 @@
+{
+  "module": "./esm/index.js",
+  "main": "./script/index.js",
+  "name": "document-ir",
+  "version": "0.0.6",
+  "description": "Intermediate representation and transformers for documents",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cendyne/document-ir.git"
+  },
+  "bugs": {
+    "url": "https://github.com/cendyne/document-ir/issues"
+  },
+  "exports": {
+    ".": {
+      "import": "./esm/index.js",
+      "require": "./script/index.js"
+    }
+  },
+  "scripts": {
+    "test": "node test_runner.js"
+  },
+  "devDependencies": {
+    "@types/node": "^18.11.9",
+    "picocolors": "^1.0.0",
+    "@deno/shim-deno": "~0.16.1"
+  }
+}

package/script/ArrayCollapseTransformer.d.ts

@@ -0,0 +1,5 @@
+import { IdentityTransformer } from "./IdentityTransformer.js";
+import { Node } from "./types.js";
+export declare class ArrayCollapseTransformer extends IdentityTransformer {
+    protected chooseChildren(nodes: Node[]): Promise<Node[]>;
+}

package/script/ArrayCollapseTransformer.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArrayCollapseTransformer = void 0;
+const IdentityTransformer_js_1 = require("./IdentityTransformer.js");
+class ArrayCollapseTransformer extends IdentityTransformer_js_1.IdentityTransformer {
+    async chooseChildren(nodes) {
+        const children = await super.chooseChildren(nodes);
+        const results = [];
+        for (const child of children) {
+            if (child.type == "array") {
+                for (const arrayChild of child.content) {
+                    results.push(arrayChild);
+                }
+            }
+            else {
+                results.push(child);
+            }
+        }
+        return results;
+    }
+}
+exports.ArrayCollapseTransformer = ArrayCollapseTransformer;

package/script/ArrayCollapseTransformer_test.d.ts

@@ -0,0 +1 @@
+export {};

package/script/ExampleDocument.d.ts

@@ -0,0 +1,2 @@
+import { DocumentNode } from "./types.js";
+export declare const ExampleDocument: DocumentNode;

package/script/IdentityTransformer.d.ts

@@ -0,0 +1,53 @@
+import { ArrayNode, BlockNode, BlockQuoteNode, BoldNode, BreakNode, BubbleNode, CardNode, CenterNode, CodeNode, ColumnsNode, DefinitionListNode, DefinitionNode, DefinitionReferenceNode, DocumentNode, EmbedNode, EmojiNode, FigureCaptionNode, FigureImageNode, FigureNode, FormattedTextNode, HeaderNode, HighTechAlertNode, HorizontalRuleNode, ImageNode, ItalicNode, LinkNode, ListNode, Node, NoteNode, ParagraphNode, QuoteNode, RedactedNode, RegionNode, ScriptNode, SecretNode, SmallerNode, SocialNode, StickerNode, StrikeThroughNode, TableNode, TextNode, UnderlineNode, VideoNode, WarningNode } from "./types.js";
+export declare class IdentityTransformer {
+    protected beforeBlock(): Promise<void>;
+    protected afterBlock(): Promise<void>;
+    protected beforeInline(): Promise<void>;
+    protected afterInline(): Promise<void>;
+    protected chooseChildren(nodes: Node[]): Promise<Node[]>;
+    protected block(node: BlockNode): Promise<Node | null>;
+    protected blockQuote(node: BlockQuoteNode): Promise<Node | null>;
+    protected bold(node: BoldNode): Promise<Node | null>;
+    protected break_(_node: BreakNode): Promise<Node | null>;
+    protected bubble(node: BubbleNode): Promise<Node | null>;
+    protected center(node: CenterNode): Promise<Node | null>;
+    protected code(node: CodeNode): Promise<Node | null>;
+    protected columns(node: ColumnsNode): Promise<Node | null>;
+    protected definition(node: DefinitionNode): Promise<DefinitionNode | null>;
+    protected definitionList(node: DefinitionListNode): Promise<Node | null>;
+    protected definitionReference(node: DefinitionReferenceNode): Promise<Node | null>;
+    protected embed(node: EmbedNode): Promise<Node | null>;
+    protected emoji(node: EmojiNode): Promise<Node | null>;
+    protected figure(node: FigureNode): Promise<Node | null>;
+    protected figureCaption(node: FigureCaptionNode): Promise<Node | null>;
+    protected figureImage(node: FigureImageNode): Promise<Node | null>;
+    protected formattedText(node: FormattedTextNode): Promise<Node | null>;
+    protected header(node: HeaderNode): Promise<Node | null>;
+    protected highTechAlert(node: HighTechAlertNode): Promise<Node | null>;
+    protected horizontalRule(_node: HorizontalRuleNode): Promise<Node | null>;
+    protected image(node: ImageNode): Promise<Node | null>;
+    protected italic(node: ItalicNode): Promise<Node | null>;
+    protected link(node: LinkNode): Promise<Node | null>;
+    protected array(node: ArrayNode): Promise<Node | null>;
+    protected note(node: NoteNode): Promise<Node | null>;
+    protected list(node: ListNode): Promise<Node | null>;
+    protected paragraph(node: ParagraphNode): Promise<Node | null>;
+    protected quote(node: QuoteNode): Promise<Node | null>;
+    protected redacted(node: RedactedNode): Promise<Node | null>;
+    protected region(node: RegionNode): Promise<Node | null>;
+    protected script(node: ScriptNode): Promise<Node | null>;
+    protected secret(node: SecretNode): Promise<Node | null>;
+    protected smaller(node: SmallerNode): Promise<Node | null>;
+    protected sticker(node: StickerNode): Promise<Node | null>;
+    protected strikeThrough(node: StrikeThroughNode): Promise<Node | null>;
+    protected text(node: TextNode): Promise<Node | null>;
+    protected table(node: TableNode): Promise<Node | null>;
+    protected social(node: SocialNode): Promise<Node | null>;
+    protected underline(node: UnderlineNode): Promise<Node | null>;
+    protected video(node: VideoNode): Promise<Node | null>;
+    protected warning(node: WarningNode): Promise<Node | null>;
+    protected card(node: CardNode): Promise<Node | null>;
+    protected choose(node: Node): Promise<Node | null>;
+    protected document(node: DocumentNode): Promise<DocumentNode>;
+    transform(node: DocumentNode): Promise<DocumentNode>;
+}