@oxide/react-asciidoc 0.2.8 → 0.2.9--canary.c5bf581.0

package/dist/types/utils/prepareDocument.d.ts

@@ -0,0 +1,142 @@
+import type * as AdocTypes from '@asciidoctor/core';
+type NodeType = 'audio' | 'admonition' | 'colist' | 'cell' | 'dlist' | 'document' | 'embedded' | 'example' | 'floating_title' | 'image' | 'inline_anchor' | 'inline_break' | 'inline_button' | 'inline_callout' | 'inline_footnote' | 'inline_image' | 'inline_kbd' | 'inline_menu' | 'inline_quoted' | 'listing' | 'list_item' | 'literal' | 'olist' | 'open' | 'outline' | 'page_break' | 'paragraph' | 'pass' | 'preamble' | 'quote' | 'section' | 'sidebar' | 'stem' | 'table' | 'table_cell' | 'thematic_break' | 'toc' | 'ulist' | 'verse' | 'video';
+type ContentModel = 'compound' | 'simple' | 'verbatim' | 'raw' | 'empty';
+export type BaseBlock = {
+    id: string;
+    type: NodeType;
+    blocks: Block[];
+    content: string | undefined;
+    attributes: Record<string, string>;
+    contentModel: ContentModel | undefined;
+    lineNumber: number | undefined;
+    style: string | undefined;
+    role: string | undefined;
+    title: string | undefined;
+    level: number;
+};
+export type Block = BaseBlock | ParagraphBlock | AdmonitionBlock | CoListBlock | ImageBlock | LiteralBlock | SectionBlock | TableBlock;
+export type DocumentSection = {
+    id: string;
+    title: string;
+    level: number;
+    num: string;
+    sections: DocumentSection[];
+};
+export type DocumentBlock = {
+    type: 'document';
+    title: string;
+    hasHeader: boolean;
+    noHeader: boolean;
+    attributes: Record<string, string>;
+    blocks: Block[];
+    contentModel: ContentModel | undefined;
+    footnotes: {
+        text: string | undefined;
+        index: number | undefined;
+    }[];
+    sections: DocumentSection[];
+    authors: {
+        name: string | undefined;
+        email: string | undefined;
+    }[];
+};
+export interface ParagraphBlock extends BaseBlock {
+    type: 'paragraph';
+}
+export interface AdmonitionBlock extends BaseBlock {
+    type: 'admonition';
+    iconUri: string;
+}
+export interface AudioBlock extends BaseBlock {
+    type: 'audio';
+    mediaUri: string;
+    autoplay: boolean;
+    noControls: boolean;
+    loop: boolean;
+}
+export interface ImageBlock extends BaseBlock {
+    type: 'image';
+    imageUri: string;
+}
+export interface ListItemBlock extends BaseBlock {
+    text: string | undefined;
+}
+export interface ListBlock extends BaseBlock {
+    items: ListItemBlock[];
+}
+export interface CoListBlock extends ListBlock {
+    type: 'colist';
+}
+export interface DListBlock extends BaseBlock {
+    type: 'dlist';
+    items: (ListItemBlock | ListItemBlock[])[][];
+}
+export interface LiteralBlock extends BaseBlock {
+    type: 'listing';
+    source: string;
+    language: string | undefined;
+}
+export interface SectionBlock extends BaseBlock {
+    type: 'section';
+    level: number;
+    numbered: boolean;
+    title: string;
+    num: string;
+    name: string;
+}
+export interface TableBlock extends BaseBlock {
+    caption: string;
+    columns: Column[];
+    rows: Row;
+    headRows: Cell[][];
+    bodyRows: Cell[][];
+    footRows: Cell[][];
+    hasHeader: boolean;
+    hasFooter: boolean;
+    hasAutowidth: boolean;
+}
+export type Column = {
+    attributes: Record<string, string>;
+    columnNumber: number;
+    width: string | undefined;
+    horizontalAlign: string | undefined;
+    verticalAlign: string | undefined;
+    style: string | undefined;
+};
+export type Row = {
+    head: Cell[][];
+    body: Cell[][];
+    foot: Cell[][];
+};
+export interface Cell extends BaseBlock {
+    type: NodeType;
+    attributes: Record<string, string>;
+    columnSpan: number | undefined;
+    rowSpan: number | undefined;
+    content: string | undefined;
+    text: string;
+    source: string;
+    lines: string[];
+    lineNumber: number | undefined;
+    style: string | undefined;
+    column: Column | undefined;
+    width: string | undefined;
+    columnPercentageWidth: string | undefined;
+}
+/**
+ * A convenience method to check if the specified option attribute is enabled on the current node.
+ * Check if the option is enabled. This method simply checks to see if the <name>-option attribute is defined on the current node.
+ */
+export declare const isOption: (attrs: Record<string, string>, option: string) => boolean;
+/**
+ * Get the value of the specified attribute.
+ * If the attribute is not found on this node, fallback_name is set, and this node is not the Document node, get the value of the specified attribute from the Document node.
+ *
+ * Look for the specified attribute in the attributes on this node and return the value of the attribute, if found.
+ * Otherwise, if fallback_name is set (default: same as name) and documentAttrs is included, look for that attribute on the Document node and return its value, if found.
+ * Otherwise, return the default value (default: undefined).
+ */
+export declare const getAttribute: (attrs: Record<string, string>, name: string, defaultValue?: any, fallbackName?: string, documentAttrs?: Record<string, string>) => any;
+export declare const hasAttribute: (attrs: Record<string, string>, name: string) => boolean;
+export declare const prepareDocument: (document: AdocTypes.Document) => DocumentBlock;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oxide/react-asciidoc",
-  "version": "0.2.8",
+  "version": "0.2.9--canary.c5bf581.0",
   "files": [
     "dist"
   ],
@@ -33,7 +33,6 @@
   "author": "Oxide Computer Company <bots@oxidecomputer.com>",
   "license": "MPL 2.0",
   "dependencies": {
-    "@asciidoctor/core": "^3.0.2",
     "classnames": "^2.3.2",
     "highlight.js": "^11.6.0",
     "html-react-parser": "^4.2.2",
@@ -41,6 +40,7 @@
     "vitest": "^0.24.3"
   },
   "devDependencies": {
+    "@asciidoctor/core": "^3.0.2",
     "@playwright/test": "^1.27.1",
     "@trivago/prettier-plugin-sort-imports": "^3.3.0",
     "@types/node": "^18.15.11",