Better organization

Author: samouri

src/ast.ts

@@ -14,38 +14,7 @@
  * limitations under the License.
  */
 import {getTagId} from './htmltagenum.js';
-
-/**
- * @file Provides interfaces and helper functions for handling a JSON representation of HTML.
- */
-
-export interface TreeProto {
-  tree: [DocumentNodeProto];
-  quirks_mode: undefined | boolean;
-  root: number;
-}
-
-export interface TextNodeProto {
-  value: string;
-  num_terms: number;
-}
-export interface ElementNodeProto {
-  tagid: number;
-  value: string;
-  attributes: Array<AttributeProto>;
-  children: Array<NodeProto>;
-}
-
-export interface DocumentNodeProto {
-  tagid: 92; // See htmltagenum.ts
-  children: Array<NodeProto>;
-}
-
-export type NodeProto = TextNodeProto | ElementNodeProto;
-export interface AttributeProto {
-  name: string;
-  value?: string;
-}
+import {NodeProto, ElementNodeProto, TreeProto} from './protos.js';
 
 export function isElementNode(node: NodeProto): node is ElementNodeProto {
   return (node as any).tagid !== undefined;

src/dom.ts

@@ -13,7 +13,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import {isElementNode, NodeProto, TreeProto} from './ast.js';
+import {isElementNode} from './ast.js';
+import {TreeProto, NodeProto} from './protos.js';
 
 // TypeScript doesn't understand importing a file with a .mjs extension, but it is perfectly valid once transpiled
 // See: https://github.com/microsoft/TypeScript/issues/27957

src/index.ts

@@ -15,17 +15,9 @@
  */
 import * as ast from './ast.js';
 import * as dom from './dom.js';
+import {TreeProto} from './protos.js';
 
-// Reexport all types from ast
-export type {
-  TreeProto,
-  DocumentNodeProto,
-  NodeProto,
-  ElementNodeProto,
-  TextNodeProto,
-  AttributeProto,
-} from './ast.js';
-
+export * as protos from './protos.js';
 export interface InstructionMap {
   [key: string]: (element: Element) => void;
 }
@@ -35,10 +27,10 @@ function defaultHandleError(tagName, e: Error) {
 }
 
 export function renderAst(
-  tree: ast.TreeProto,
+  tree: TreeProto,
   instructions: InstructionMap,
   {handleError = defaultHandleError} = {}
-): ast.TreeProto {
+): TreeProto {
   const doc = dom.fromTreeProto(tree);
 
   // TODO: Optimization opportunity by writing a custom walk instead of N querySelectorAll.

src/protos.ts

@@ -0,0 +1,29 @@
+export interface TreeProto {
+  tree: [DocumentNodeProto];
+  quirks_mode: undefined | boolean;
+  root: number;
+}
+
+export interface DocumentNodeProto {
+  tagid: 92; // See htmltagenum.ts
+  children: Array<NodeProto>;
+}
+
+export type NodeProto = TextNodeProto | ElementNodeProto;
+
+export interface TextNodeProto {
+  value: string;
+  num_terms: number;
+}
+
+export interface ElementNodeProto {
+  tagid: number;
+  value: string;
+  attributes: Array<AttributeProto>;
+  children: Array<NodeProto>;
+}
+
+export interface AttributeProto {
+  name: string;
+  value?: string;
+}

test/html-utils.ts

@@ -14,13 +14,8 @@
  * limitations under the License.
  */
 import * as parse5 from 'parse5';
-import {
-  DocumentNodeProto,
-  getNumTerms,
-  isElementNode,
-  NodeProto,
-  TreeProto,
-} from '../src/ast.js';
+import {getNumTerms, isElementNode} from '../src/ast.js';
+import {DocumentNodeProto, NodeProto, TreeProto} from '../src/protos.js';
 import {getTagId} from '../src/htmltagenum.js';
 import {renderAst, InstructionMap} from '../src/index.js';
 

test/test-dom.ts

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import {DocumentNodeProto, NodeProto, TreeProto} from '../src/ast.js';
+import {DocumentNodeProto, NodeProto, TreeProto} from '../src/protos.js';
 
 import test from 'ava';
 import {fromTreeProto} from '../src/dom.js';

test/test-index.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import test from 'ava';
-import {DocumentNodeProto, NodeProto, TreeProto} from '../src/ast.js';
+import {DocumentNodeProto, NodeProto, TreeProto} from '../src/protos.js';
 import {getTagId} from '../src/htmltagenum.js';
 import {renderAst} from '../src/index.js';