dexin-content 0.1.2 → 0.2.0

package/core/types.ts

@@ -1,162 +0,0 @@
-// ─────────────────────────────────────────────────────────────
-// dexin-content/core/types.ts — Generic shared types.
-// ─────────────────────────────────────────────────────────────
-// This file defines the shared type system used across domains.
-// It MUST remain business-agnostic. All names, literals, and
-// comment text are written in generic, domain-neutral vocabulary.
-
-// ── Inline content (shared across the neutral AST and all domains) ──
-
-export type Inline =
-  | TextInline
-  | BoldInline
-  | ItalicInline
-  | CodeInline
-  | LinkInline
-  | FormulaInline
-
-export interface TextInline { type: 'text'; value: string }
-export interface BoldInline { type: 'bold'; children: Inline[] }
-export interface ItalicInline { type: 'italic'; children: Inline[] }
-export interface CodeInline { type: 'code'; value: string }
-export interface LinkInline { type: 'link'; url: string; children: Inline[] }
-/** Inline LaTeX-format formula span (single-paragraph). */
-export interface FormulaInline { type: 'math'; latex: string }
-
-// ── Document-level blocks (neutral AST — no domain mapping) ──
-
-/**
- * HeadingBlock in the neutral AST: level is clamped to 1–4
- * (h1→1, h2→2, h3→3, h4→4). `mdDepth` is the ORIGINAL markdown heading
- * depth (1..6 inclusive) captured at parse time. It is OPTIONAL and exists
- * ONLY so active domain parsers can run their own fail-fast checks for
- * out-of-range depths. `mdDepth` MUST NOT leak into the serialised
- * canonical Artifact (the `content` output): domain parsers' clone/render
- * paths must drop it.
- */
-export interface HeadingBlock {
-  type: 'heading'
-  level: 1 | 2 | 3 | 4
-  children: Inline[]
-  /** Original markdown heading depth (1..6). Transient, non-canonical. */
-  mdDepth?: number
-}
-export interface ParagraphBlock { type: 'paragraph'; children: Inline[] }
-export interface QuoteBlock { type: 'quote'; children: DocumentBlock[] }
-export interface DividerBlock { type: 'divider' }
-export interface ListBlock { type: 'list'; ordered: boolean; items: Inline[][] }
-export type TableCell = Inline[]
-export interface TableBlock { type: 'table'; headers: TableCell[]; rows: TableCell[][] }
-export interface ImageBlock { type: 'image'; src: string; alt: string; caption?: string }
-export interface CodeBlock { type: 'code'; language: string; code: string }
-/** Block-level LaTeX-format formula node; display=true for centered fences. */
-export interface FormulaBlock { type: 'formula'; latex: string; display: boolean }
-
-/**
- * Neutral ContainerBlock:
- * Produced for every directive container encountered in the markdown body.
- * The active domain decides whether an unknown name is acceptable;
- * the generic layer always preserves the structure as-is.
- */
-export interface ContainerBlock {
-  type: 'container'
-  name: string
-  attrs: Record<string, string>
-  children: DocumentBlock[]
-}
-
-export type DocumentBlock =
-  | ParagraphBlock
-  | HeadingBlock
-  | QuoteBlock
-  | DividerBlock
-  | ListBlock
-  | TableBlock
-  | ImageBlock
-  | CodeBlock
-  | FormulaBlock
-  | ContainerBlock
-
-export interface DocumentContent {
-  version: 1
-  blocks: DocumentBlock[]
-}
-
-// ── Artifact shapes (shared five-field header) ──
-
-/**
- * Generic domain tag. Literal string values are chosen by the host runner
- * and flow through to the Artifact output untouched. Core itself does not
- * interpret them beyond registry lookup keys.
- */
-export type DomainName = string & { readonly __brand?: unique symbol }
-
-/**
- * Plain-document identity:
- *   id    — relative to content root; strip `.md` and trailing `/index`
- *   path  — URL semantics: `'/' + id`
- *   file  — physical path relative to content root, INCLUDING `.md` extension
- *
- * Domain-specific routing fields may be attached by hosts via the index
- * signature; core never interprets them.
- */
-export interface DocumentIdentity {
-  id: string
-  path: string        // URL semantic: '/' + id
-  file: string        // physical path relative to content root WITH ext
-  collection: string
-  [k: string]: unknown   // auxiliary fields (e.g. index_file:true)
-}
-
-/** Frontmatter scalar-only projection (SCHEMA-FREE RULE) */
-export type Meta = Record<string, string | number | boolean>
-
-export interface ArtifactHeader {
-  id: string               // Stable document id (unique within a store)
-  domain: DomainName | string
-  identity: DocumentIdentity
-  meta: Meta
-}
-
-export interface PositiveArtifact extends ArtifactHeader {
-  content: { version: 1; blocks: unknown[] }
-}
-
-/** Compile-failure output — captures first fail-fast error. */
-export interface ErrorArtifact extends ArtifactHeader {
-  kind: 'COMPILE_ERROR'
-  error: { code: string; message: string }
-}
-
-export type Artifact = PositiveArtifact | ErrorArtifact
-
-// ── Unified error object ──
-
-export interface ParseError extends Error {
-  code: string
-  message: string
-  file: string
-  loc?: { container?: string; headingDepth?: number; invalidEnumValue?: string; allowed?: string }
-}
-
-// ── Parser contract — domains implement; core dispatches ──
-
-export interface ParseContext {
-  /** Relative path to the source file, used in error messages. */
-  file: string
-  /** Collection-level schema (required fields + scalar type checks). */
-  schema?: Schema
-  /** Frontmatter already projected as scalar-only meta. */
-  meta: Meta
-}
-
-export interface Schema {
-  required?: string[]
-  types?: Record<string, 'string' | 'number' | 'boolean'>
-}
-
-export interface DomainParser {
-  domain: DomainName | string
-  /** Convert neutral AST → domain-specific Artifact content.blocks shape. May throw ParseError. */
-  parse(content: DocumentContent, ctx: ParseContext): { version: 1; blocks: unknown[] }
-}