@lexbuild/core 1.0.0 → 1.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Chris Thomas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,102 @@
+# @lexbuild/core
+
+[![npm](https://img.shields.io/npm/v/%40lexbuild%2Fcore?style=flat-square)](https://www.npmjs.com/package/@lexbuild/core)
+[![license](https://img.shields.io/github/license/chris-c-thomas/lexbuild?style=flat-square)](https://github.com/chris-c-thomas/lexbuild/blob/main/LICENSE)
+
+This package is part of the [LexBuild](https://github.com/chris-c-thomas/lexbuild) monorepo, a tool that converts U.S. legislative XML into structured Markdown optimized for AI, RAG pipelines, and semantic search. See the monorepo for full documentation, architecture details, and contribution guidelines.
+
+It provides the foundational building blocks for XML parsing infrastructure, AST definitions, and Markdown rendering for use by [`@lexbuild/usc`](https://www.npmjs.com/package/@lexbuild/usc) and [`@lexbuild/cli`](https://www.npmjs.com/package/@lexbuild/cli).
+
+## Install
+
+```bash
+npm install @lexbuild/core
+```
+
+## What's Included
+
+### XML Parser
+
+Streaming SAX parser with namespace normalization for USLM documents.
+
+```ts
+import { XMLParser } from "@lexbuild/core";
+
+const parser = new XMLParser();
+parser.on("openElement", (name, attrs) => { /* ... */ });
+parser.on("closeElement", (name) => { /* ... */ });
+parser.on("text", (text) => { /* ... */ });
+
+await parser.parseStream(readableStream);
+```
+
+### AST Builder
+
+Stack-based XML-to-AST construction with a section-emit pattern for bounded memory usage.
+
+```ts
+import { ASTBuilder } from "@lexbuild/core";
+
+const builder = new ASTBuilder({
+  emitAt: "section",
+  onEmit: (node, context) => {
+    // Called with each completed section subtree
+  },
+});
+```
+
+### Markdown Renderer
+
+Stateless AST-to-Markdown conversion with YAML frontmatter, cross-reference link resolution, and notes filtering.
+
+```ts
+import { renderDocument, generateFrontmatter, createLinkResolver } from "@lexbuild/core";
+
+const markdown = renderDocument(sectionNode, frontmatterData, {
+  linkStyle: "relative",
+  resolveLink: resolver.resolve,
+});
+```
+
+### AST Node Types
+
+Full type definitions for the legislative document AST: `LevelNode`, `ContentNode`, `InlineNode`, `NoteNode`, `TableNode`, and more.
+
+```ts
+import type { ASTNode, LevelNode, FrontmatterData, RenderOptions } from "@lexbuild/core";
+```
+
+### Namespace Constants
+
+USLM, XHTML, Dublin Core namespace URIs and element classification sets.
+
+```ts
+import { USLM_NS, XHTML_NS, LEVEL_ELEMENTS, CONTENT_ELEMENTS } from "@lexbuild/core";
+```
+
+## API Reference
+
+| Export | Description |
+|--------|-------------|
+| `XMLParser` | Streaming SAX parser with namespace normalization |
+| `ASTBuilder` | XML events to AST with section-emit pattern |
+| `renderDocument()` | Render a section node with frontmatter to Markdown |
+| `renderSection()` | Render a section-level node to Markdown |
+| `renderNode()` | Render any AST node to Markdown |
+| `generateFrontmatter()` | Generate YAML frontmatter block |
+| `createLinkResolver()` | Create a cross-reference link resolver |
+| `parseIdentifier()` | Parse a USLM identifier into components |
+| `FORMAT_VERSION` | Output format version (`"1.0.0"`) |
+| `GENERATOR` | Generator string for frontmatter |
+
+## Documentation
+
+- [Monorepo README](https://github.com/chris-c-thomas/lexbuild#readme)
+- [Architecture](https://github.com/chris-c-thomas/lexbuild/blob/main/docs/architecture.md)
+- [Output Format](https://github.com/chris-c-thomas/lexbuild/blob/main/docs/output-format.md)
+- [XML Element Reference](https://github.com/chris-c-thomas/lexbuild/blob/main/docs/xml-element-reference.md)
+- [Extending](https://github.com/chris-c-thomas/lexbuild/blob/main/docs/extending.md)
+
+## License
+
+[MIT](https://github.com/chris-c-thomas/lexbuild/blob/main/LICENSE)

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@lexbuild/core",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Core AST definitions, parsing infrastructure, and format-agnostic renderers for the lexbuild ecosystem.",
   "author": "Chris Thomas",
   "license": "MIT",
-  "homepage": "https://github.com/chris-c-thomas/lexbuild#readme",
+  "homepage": "https://github.com/chris-c-thomas/lexbuild/tree/main/packages/core#readme",
   "bugs": {
     "url": "https://github.com/chris-c-thomas/lexbuild/issues"
   },
@@ -40,15 +40,6 @@
   "files": [
     "dist"
   ],
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch",
-    "typecheck": "tsc --noEmit",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "lint": "eslint src",
-    "lint:fix": "eslint src --fix"
-  },
   "dependencies": {
     "saxes": "^6.0.0",
     "yaml": "^2.7.0",
@@ -65,5 +56,14 @@
   },
   "publishConfig": {
     "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint src",
+    "lint:fix": "eslint src --fix"
   }
 }