@pyreon/document-primitives 0.24.5 → 0.25.0

package/src/__tests__/useDocumentExport.test.ts

@@ -1,366 +0,0 @@
-import type { DocumentMarker } from '@pyreon/connector-document'
-import { h } from '@pyreon/core'
-import { describe, expect, it } from 'vitest'
-import { createDocumentExport, extractDocNode } from '../useDocumentExport'
-
-// Helper: build a real VNode via @pyreon/core's h(). The third arg
-// is an array (kept for parity with the prior mock helper) and
-// spreads into h()'s varargs. Tests run real-h() VNodes through
-// the export pipeline — the mock-only path masked PR #197's silent
-// metadata drop bug.
-const node = (
-  type: string | ((...args: any[]) => any),
-  props: Record<string, any> = {},
-  children: unknown[] = [],
-) => h(type as any, props, ...(children as any[])) as any
-
-// Document-marked component
-const docComponent = (docType: string) => {
-  const fn = (props: any) => node('div', props, props.children ? [props.children] : [])
-  ;(fn as any)._documentType = docType
-  return fn as ((...args: any[]) => any) & DocumentMarker
-}
-
-const DocDocument = docComponent('document')
-const DocHeading = docComponent('heading')
-const DocText = docComponent('text')
-
-describe('createDocumentExport', () => {
-  it('extracts a document tree from template function', () => {
-    const doc = createDocumentExport(() =>
-      node(DocDocument, { _documentProps: { title: 'Test' } }, [
-        node(
-          DocHeading,
-          {
-            $rocketstyle: { fontSize: 24, fontWeight: 'bold' },
-            _documentProps: { level: 1 },
-          },
-          ['Hello'],
-        ),
-        node(
-          DocText,
-          {
-            $rocketstyle: { fontSize: 14, color: '#333' },
-          },
-          ['World'],
-        ),
-      ]),
-    )
-
-    const tree = doc.getDocNode()
-
-    expect(tree.type).toBe('document')
-    expect(tree.props.title).toBe('Test')
-    expect(tree.children).toHaveLength(2)
-
-    const heading = tree.children[0] as any
-    expect(heading.type).toBe('heading')
-    expect(heading.props.level).toBe(1)
-    expect(heading.styles?.fontSize).toBe(24)
-    expect(heading.children).toEqual(['Hello'])
-
-    const text = tree.children[1] as any
-    expect(text.type).toBe('text')
-    expect(text.styles?.fontSize).toBe(14)
-    expect(text.styles?.color).toBe('#333')
-  })
-
-  it('can be called multiple times', () => {
-    const doc = createDocumentExport(() =>
-      node(DocText, { $rocketstyle: { fontSize: 14 } }, ['Static']),
-    )
-
-    const tree1 = doc.getDocNode()
-    const tree2 = doc.getDocNode()
-
-    expect(tree1.type).toBe('text')
-    expect(tree2.type).toBe('text')
-  })
-
-  it('respects includeStyles option', () => {
-    const doc = createDocumentExport(
-      () => node(DocHeading, { $rocketstyle: { fontSize: 24 } }, ['Hello']),
-      { includeStyles: false },
-    )
-
-    const tree = doc.getDocNode()
-    expect(tree.styles).toBeUndefined()
-  })
-
-  it('handles empty template', () => {
-    const doc = createDocumentExport(() => null)
-
-    const tree = doc.getDocNode()
-    expect(tree.type).toBe('document')
-    expect(tree.children).toEqual([])
-  })
-})
-
-describe('extractDocNode (one-step alias)', () => {
-  // The one-step form. Equivalent to
-  // `createDocumentExport(templateFn).getDocNode()` but without
-  // the wrapper-object indirection. This is the form most
-  // consumers should use.
-
-  it('extracts a tree from a template function in one call', () => {
-    const tree = extractDocNode(() =>
-      node(DocDocument, { _documentProps: { title: 'Test' } }, [
-        node(DocHeading, { _documentProps: { level: 1 } }, ['Hello']),
-      ]),
-    )
-
-    expect(tree.type).toBe('document')
-    expect(tree.props.title).toBe('Test')
-    expect(tree.children).toHaveLength(1)
-    const heading = tree.children[0] as { type: string; props: Record<string, unknown> }
-    expect(heading.type).toBe('heading')
-    expect(heading.props.level).toBe(1)
-  })
-
-  it('respects extraction options (includeStyles: false)', () => {
-    const tree = extractDocNode(
-      () => node(DocHeading, { $rocketstyle: { fontSize: 24 } }, ['Hello']),
-      { includeStyles: false },
-    )
-    expect(tree.styles).toBeUndefined()
-  })
-
-  it('returns the same tree shape as createDocumentExport().getDocNode()', () => {
-    // Equivalence guarantee — the two-step form delegates to the
-    // one-step form internally, so they MUST produce identical
-    // output for identical input.
-    const template = () =>
-      node(DocText, { $rocketstyle: { fontSize: 14 } }, ['Hello'])
-
-    const oneStep = extractDocNode(template)
-    const twoStep = createDocumentExport(template).getDocNode()
-
-    expect(oneStep).toEqual(twoStep)
-  })
-
-  it('is idempotent — calling extractDocNode twice on the same template produces equivalent results', () => {
-    // The framework fix in PR #197 changed extractDocumentTree to
-    // CALL the component function for documentType vnodes when
-    // _documentProps is not directly on the JSX vnode. The fix is
-    // correct because rocketstyle's attrs HOC is meant to be pure
-    // setup with no observable side effects on the second call.
-    // This test locks in that purity assumption: extracting the
-    // same template twice produces structurally equivalent doc
-    // nodes.
-    //
-    // If a future change to a primitive accidentally introduces a
-    // side effect in its attrs callback (e.g. a counter, a log
-    // line, a stateful import), the second extraction would still
-    // SUCCEED but produce different output — and this test would
-    // catch the regression. The three extractions should be deeply
-    // equal under any change to the primitive's setup path.
-    const template = () =>
-      node(
-        DocDocument,
-        { _documentProps: { title: 'Idempotent', author: 'Test' } },
-        [
-          node(DocHeading, { _documentProps: { level: 1 } }, ['Hello']),
-          node(DocText, { $rocketstyle: { fontSize: 14 } }, ['World']),
-        ],
-      )
-
-    const first = extractDocNode(template)
-    const second = extractDocNode(template)
-    const third = extractDocNode(template)
-
-    expect(first).toEqual(second)
-    expect(second).toEqual(third)
-  })
-
-  it('resolves function values in _documentProps each call (D1+D2 integration)', () => {
-    // The combined contract: extractDocNode is the one-step form,
-    // and it benefits from the same function-value resolution
-    // that extractDocumentTree does. Each call sees the live
-    // value of any accessor in _documentProps.
-    let counter = 0
-    const template = () =>
-      node(
-        DocDocument,
-        {
-          _documentProps: {
-            title: () => `Export ${++counter}`,
-            author: 'Plain string still works',
-          },
-        },
-        [],
-      )
-
-    const first = extractDocNode(template)
-    const second = extractDocNode(template)
-
-    expect(first.props.title).toBe('Export 1')
-    expect(first.props.author).toBe('Plain string still works')
-    expect(second.props.title).toBe('Export 2')
-  })
-})
-
-describe('DocDocument reactive metadata (D1 integration)', () => {
-  // The end-to-end contract: a real DocDocument primitive (NOT a
-  // mock vnode) accepts accessor functions for title/author/subject,
-  // stores them in _documentProps, and the export pipeline reads
-  // the LIVE values at extraction time.
-  //
-  // This test mounts DocDocument as if from JSX (via h()) and
-  // extracts the resulting tree, then mutates the closure-captured
-  // state and re-extracts to prove the second extraction sees the
-  // updated value. The previous tests use mock vnodes — this one
-  // uses the real primitive.
-
-  // Long timeout: this test dynamic-imports @pyreon/test-utils,
-  // @pyreon/core, and DocDocument inside the test body. Each
-  // dynamic import triggers Vite's transform pipeline (JSX
-  // compilation, rocketstyle wrapping, etc.) which takes 5+
-  // seconds on slow CI runners on first hit. The default 5000ms
-  // timeout fails reliably on CI.
-  it('DocDocument with accessor title produces live values across multiple extractions', { timeout: 60_000 }, async () => {
-    // Use happy-dom + initTestConfig like the rest of the test suite
-    const { initTestConfig } = await import('@pyreon/test-utils')
-    const { h } = await import('@pyreon/core')
-    const cleanup = initTestConfig()
-    try {
-      // Real DocDocument from the package (not the mock above)
-      const RealDocDocument = (await import('../primitives/DocDocument')).default
-
-      // Closure state that the accessor reads from. Mutating it
-      // between extractions simulates a signal change.
-      let currentName = 'Aisha'
-      const titleAccessor = () => `${currentName} — Resume`
-      const authorAccessor = () => currentName
-
-      // Build the template via h() so DocDocument's attrs callback
-      // runs (storing the accessor functions in _documentProps).
-      const template = () =>
-        h(
-          RealDocDocument as never,
-          { title: titleAccessor, author: authorAccessor } as never,
-        )
-
-      const first = extractDocNode(template)
-      expect(first.type).toBe('document')
-      expect(first.props.title).toBe('Aisha — Resume')
-      expect(first.props.author).toBe('Aisha')
-
-      // Mutate the closure-captured name. The next extraction
-      // should see the new value because extractDocumentTree calls
-      // the function fresh.
-      currentName = 'Marcus'
-      const second = extractDocNode(template)
-      expect(second.props.title).toBe('Marcus — Resume')
-      expect(second.props.author).toBe('Marcus')
-
-      // And once more for good measure
-      currentName = 'Priya'
-      const third = extractDocNode(template)
-      expect(third.props.title).toBe('Priya — Resume')
-      expect(third.props.author).toBe('Priya')
-    } finally {
-      cleanup()
-    }
-  })
-
-  it('DocDocument with plain string title still works (backward compat)', { timeout: 30_000 }, async () => {
-    const { initTestConfig } = await import('@pyreon/test-utils')
-    const { h } = await import('@pyreon/core')
-    const cleanup = initTestConfig()
-    try {
-      const RealDocDocument = (await import('../primitives/DocDocument')).default
-
-      const tree = extractDocNode(() =>
-        h(
-          RealDocDocument as never,
-          { title: 'Static title', author: 'Static author' } as never,
-        ),
-      )
-
-      expect(tree.props.title).toBe('Static title')
-      expect(tree.props.author).toBe('Static author')
-    } finally {
-      cleanup()
-    }
-  })
-
-  it('DocDocument subject prop also accepts both string and accessor (full prop coverage)', { timeout: 30_000 }, async () => {
-    // The widening covered all three metadata props (title, author,
-    // subject). The previous tests only exercise title and author —
-    // this test fills the coverage gap so a typo in the subject
-    // type widening would be caught.
-    const { initTestConfig } = await import('@pyreon/test-utils')
-    const { h } = await import('@pyreon/core')
-    const cleanup = initTestConfig()
-    try {
-      const RealDocDocument = (await import('../primitives/DocDocument')).default
-
-      // Plain string subject
-      const plainTree = extractDocNode(() =>
-        h(RealDocDocument as never, { subject: 'Q4 Report' } as never),
-      )
-      expect(plainTree.props.subject).toBe('Q4 Report')
-
-      // Accessor subject — value resolved at extraction time
-      let topic = 'Initial topic'
-      const accessorTree1 = extractDocNode(() =>
-        h(RealDocDocument as never, { subject: () => topic } as never),
-      )
-      expect(accessorTree1.props.subject).toBe('Initial topic')
-
-      topic = 'Updated topic'
-      const accessorTree2 = extractDocNode(() =>
-        h(RealDocDocument as never, { subject: () => topic } as never),
-      )
-      expect(accessorTree2.props.subject).toBe('Updated topic')
-    } finally {
-      cleanup()
-    }
-  })
-
-  it('extractDocNode does NOT invoke a real DocDocument component (T3.1 Path C)', { timeout: 30_000 }, async () => {
-    // The architectural invariant locked in by T3.1 (PR #321):
-    // `extractDocumentTree` consumes a real rocketstyle primitive's
-    // `__rs_attrs` chain directly, never invoking the wrapped component
-    // function. The previous Path B workaround had to call the full
-    // styled wrapper per export to read post-attrs `_documentProps`.
-    //
-    // Spy mechanism: wrap the imported component in a Proxy whose
-    // `apply` trap counts function-call invocations. Property reads
-    // (IS_ROCKETSTYLE, __rs_attrs, _documentType, .meta, .displayName,
-    // etc.) flow through to the original via the default `get` handler,
-    // so extractDocumentTree's contract still works — but any code
-    // path that CALLS the spied component bumps the counter.
-    //
-    // The connector-document tests already pin this with a
-    // `FakeRocketDoc` fixture; this test pins it for a real
-    // rocketstyle primitive end-to-end, closing the abstract /
-    // concrete coverage gap.
-    const { initTestConfig } = await import('@pyreon/test-utils')
-    const { h } = await import('@pyreon/core')
-    const cleanup = initTestConfig()
-    try {
-      const RealDocDocument = (await import('../primitives/DocDocument')).default
-
-      let callCount = 0
-      const SpiedDoc = new Proxy(RealDocDocument, {
-        apply(target, thisArg, args) {
-          callCount++
-          return Reflect.apply(target as (...a: unknown[]) => unknown, thisArg, args as unknown[])
-        },
-      })
-
-      const tree = extractDocNode(() =>
-        h(SpiedDoc as never, { title: 'Hoisted', author: 'Aisha' } as never),
-      )
-
-      expect(tree.type).toBe('document')
-      expect(tree.props.title).toBe('Hoisted')
-      expect(tree.props.author).toBe('Aisha')
-      // The architectural assertion — the styled wrapper must NOT run.
-      expect(callCount).toBe(0)
-    } finally {
-      cleanup()
-    }
-  })
-})

package/src/index.ts

@@ -1,37 +0,0 @@
-// Re-export connector utilities
-
-export type {
-  DocChild,
-  DocNode,
-  ExtractOptions,
-  NodeType,
-  ResolvedStyles,
-} from '@pyreon/connector-document'
-export { extractDocumentTree, resolveStyles } from '@pyreon/connector-document'
-// Preview
-export { default as DocumentPreview } from './DocumentPreview'
-// Primitives
-export { default as DocButton } from './primitives/DocButton'
-export { default as DocCode } from './primitives/DocCode'
-export { default as DocColumn } from './primitives/DocColumn'
-export { default as DocDivider } from './primitives/DocDivider'
-export { default as DocDocument } from './primitives/DocDocument'
-export { default as DocHeading } from './primitives/DocHeading'
-export { default as DocImage } from './primitives/DocImage'
-export { default as DocLink } from './primitives/DocLink'
-export { default as DocList } from './primitives/DocList'
-export { default as DocListItem } from './primitives/DocListItem'
-export { default as DocPage } from './primitives/DocPage'
-export { default as DocPageBreak } from './primitives/DocPageBreak'
-export { default as DocQuote } from './primitives/DocQuote'
-export { default as DocRow } from './primitives/DocRow'
-export { default as DocSection } from './primitives/DocSection'
-export { default as DocSpacer } from './primitives/DocSpacer'
-export { default as DocTable } from './primitives/DocTable'
-export { default as DocText } from './primitives/DocText'
-// Theme
-export type { DocumentTheme } from './theme'
-export { documentTheme } from './theme'
-// Export helper
-export type { DocumentExport, DocumentExportOptions } from './useDocumentExport'
-export { createDocumentExport, extractDocNode } from './useDocumentExport'