@byline/cli 3.21.0 → 4.1.0

package/dist/templates/ui-byline/render-blocks.tsx

@@ -1,41 +1,13 @@
 import { Section } from '@byline/ui/react'
 
-import type { PhotoBlockData, RichTextBlockData } from '~/generated/collection-types.js'
-
 import { PhotoBlock } from '@/ui/byline/blocks/photo-block'
 import { RichTextBlock } from '@/ui/byline/blocks/richtext-block'
-import { toKebabCase } from '@/ui/utils/to-kebab-case'
-import type { Locale } from '@/i18n/i18n-config'
-
-export type AnyBlock = PhotoBlockData | RichTextBlockData
-
-// Mapped type ensures every AnyBlock['_type'] has a registered component.
-// TypeScript errors here if AnyBlock gains a new type without a matching entry.
-type BlockRegistry = {
-  [K in AnyBlock['_type']]: React.ComponentType<{
-    id: string
-    block: Extract<AnyBlock, { _type: K }>
-    lng: Locale
-    constrainedLayout?: boolean
-  }>
-}
-
-const blockComponents: BlockRegistry = {
-  photoBlock: PhotoBlock,
-  richTextBlock: RichTextBlock,
-}
-
-// Loose alias for the call site — BlockRegistry enforces correctness at
-// definition time; TypeScript can't infer the correlation during the map loop.
-type AnyBlockComponent = React.ComponentType<{
-  id: string
-  block: AnyBlock
-  lng: Locale
-  constrainedLayout?: boolean
-}>
+import { toKebabCase } from '@/ui/byline/utils/to-kebab-case'
+import type { PopulatedContentBlock } from '@/ui/byline/types/content'
+import type { Locale } from '@/ui/byline/types/i18n'
 
 interface Props {
-  blocks: AnyBlock[] | undefined | null
+  blocks: PopulatedContentBlock[] | undefined | null
   lng: Locale
   constrainedLayout?: boolean
 }
@@ -50,13 +22,45 @@ export function RenderBlocks({
   return (
     <>
       {blocks.map((block) => {
-        const Block = blockComponents[block._type] as AnyBlockComponent
+        const content = renderBlock(block, lng, constrainedLayout)
+        if (content == null) return null
+
         return (
           <Section className={toKebabCase(block._type)} key={block._id}>
-            <Block id={block._id} block={block} lng={lng} constrainedLayout={constrainedLayout} />
+            {content}
           </Section>
         )
       })}
     </>
   )
 }
+
+function renderBlock(
+  block: PopulatedContentBlock,
+  lng: Locale,
+  constrainedLayout: boolean
+): React.JSX.Element | null {
+  switch (block._type) {
+    case 'photoBlock':
+      return (
+        <PhotoBlock id={block._id} block={block} lng={lng} constrainedLayout={constrainedLayout} />
+      )
+    case 'richTextBlock':
+      return (
+        <RichTextBlock
+          id={block._id}
+          block={block}
+          lng={lng}
+          constrainedLayout={constrainedLayout}
+        />
+      )
+    default:
+      return reportUnsupportedBlock(block)
+  }
+}
+
+function reportUnsupportedBlock(block: never): null {
+  const type = (block as { _type?: unknown })._type
+  console.error(`Unsupported content block type: "${String(type)}"`)
+  return null
+}

package/dist/templates/ui-byline/types/content.ts

@@ -0,0 +1,25 @@
+import type { WithPopulated } from '@byline/client'
+
+import type { DocsFields, MediaFields, PagesFields } from '@byline/generated-types'
+
+type ContentBlockOf<Fields extends { content?: unknown }> =
+  NonNullable<Fields['content']> extends Array<infer Block> ? Block : never
+type ContentBlock = ContentBlockOf<DocsFields> | ContentBlockOf<PagesFields>
+type PhotoBlockData = Extract<ContentBlock, { _type: 'photoBlock' }>
+type PopulatePhotoBlock<Block> = Block extends PhotoBlockData
+  ? WithPopulated<Block, 'photo', MediaFields>
+  : Block
+type PopulatePhotoBlockContent<Content> =
+  Content extends Array<infer Block> ? Array<PopulatePhotoBlock<Block>> : Content
+
+/** Photo block shape returned by reads that populate the `photo` relation. */
+export type PopulatedPhotoBlockData = WithPopulated<PhotoBlockData, 'photo', MediaFields>
+
+export type PopulatedContentBlock = PopulatePhotoBlock<ContentBlock>
+
+/** Overlay populated photo blocks while preserving each consumer's content union. */
+export type WithPopulatedPhotoBlockContent<Fields> = {
+  [Key in keyof Fields]: Key extends 'content'
+    ? PopulatePhotoBlockContent<Fields[Key]>
+    : Fields[Key]
+}

package/dist/templates/ui-byline/types/i18n.ts

@@ -1,14 +1,10 @@
 /**
  * `Locale` type used throughout the ui/byline tree as a `lng` prop type.
  *
- * The reference webapp ships its own `i18n-config.ts` that narrows this
- * to a literal union of supported locales (`'en' | 'fr' | ...`). This
- * stub keeps the type as `string` so the install builds without
- * requiring you to wire up an i18n config.
+ * This portable default stays `string` so the scaffold builds without an
+ * application-specific i18n module.
  *
- * If your app has its own i18n setup, replace this file with one that
- * re-exports your narrower `Locale` type, e.g.
- *
- *   export type { Locale } from '@/i18n/i18n-config'
+ * If your app has its own i18n setup, replace this alias with its narrower
+ * locale union or re-export that setup's `Locale` type from this file.
  */
 export type Locale = string

package/dist/test-helpers.d.ts

@@ -0,0 +1,5 @@
+import { Context } from './context.js';
+import type { Answers } from './types.js';
+export declare function createTestContext(answers?: Answers): Context;
+export declare function createTestContextAt(cwd: string, answers?: Answers): Context;
+//# sourceMappingURL=test-helpers.d.ts.map

package/dist/test-helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-helpers.d.ts","sourceRoot":"","sources":["../src/test-helpers.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAGtC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AA6BzC,wBAAgB,iBAAiB,CAAC,OAAO,GAAE,OAAY,GAAG,OAAO,CAGhE;AAED,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,OAAY,GAAG,OAAO,CAe/E"}

package/dist/test-helpers.js

@@ -0,0 +1,52 @@
+import { mkdtempSync } from 'node:fs';
+import { tmpdir } from 'node:os';
+import { join } from 'node:path';
+import { Context } from './context.js';
+import { StateStore } from './state.js';
+const noop = () => { };
+const logger = { info: noop, warn: noop, error: noop, success: noop, step: noop, raw: noop };
+const prompter = {
+    async text({ defaultValue }) {
+        return defaultValue ?? '';
+    },
+    async password() {
+        return 'password';
+    },
+    async select({ options }) {
+        const first = options[0];
+        if (!first)
+            throw new Error('test prompt has no options');
+        return first.value;
+    },
+    async confirm({ defaultValue }) {
+        return defaultValue ?? true;
+    },
+    spinner: () => ({ start: noop, stop: noop }),
+    intro: noop,
+    outro: noop,
+    note: noop,
+    cancel(message) {
+        throw new Error(message);
+    },
+};
+export function createTestContext(answers = {}) {
+    const cwd = mkdtempSync(join(tmpdir(), 'byline-cli-test-'));
+    return createTestContextAt(cwd, answers);
+}
+export function createTestContextAt(cwd, answers = {}) {
+    const state = new StateStore(cwd);
+    state.patchAnswers(answers);
+    return new Context({
+        cwd,
+        apply: true,
+        dryRun: false,
+        yes: true,
+        reset: false,
+        resetConfirmed: false,
+        cliFlags: {},
+        logger,
+        prompter,
+        state,
+    });
+}
+//# sourceMappingURL=test-helpers.js.map

package/dist/test-helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-helpers.js","sourceRoot":"","sources":["../src/test-helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAChC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAEhC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAKvC,MAAM,IAAI,GAAG,GAAG,EAAE,GAAE,CAAC,CAAA;AACrB,MAAM,MAAM,GAAW,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,CAAA;AACpG,MAAM,QAAQ,GAAa;IACzB,KAAK,CAAC,IAAI,CAAC,EAAE,YAAY,EAAE;QACzB,OAAO,YAAY,IAAI,EAAE,CAAA;IAC3B,CAAC;IACD,KAAK,CAAC,QAAQ;QACZ,OAAO,UAAU,CAAA;IACnB,CAAC;IACD,KAAK,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE;QACtB,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;QACxB,IAAI,CAAC,KAAK;YAAE,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAA;QACzD,OAAO,KAAK,CAAC,KAAK,CAAA;IACpB,CAAC;IACD,KAAK,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE;QAC5B,OAAO,YAAY,IAAI,IAAI,CAAA;IAC7B,CAAC;IACD,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAC5C,KAAK,EAAE,IAAI;IACX,KAAK,EAAE,IAAI;IACX,IAAI,EAAE,IAAI;IACV,MAAM,CAAC,OAAO;QACZ,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAA;IAC1B,CAAC;CACF,CAAA;AAED,MAAM,UAAU,iBAAiB,CAAC,OAAO,GAAY,EAAE;IACrD,MAAM,GAAG,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,kBAAkB,CAAC,CAAC,CAAA;IAC3D,OAAO,mBAAmB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;AAC1C,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,GAAW,EAAE,OAAO,GAAY,EAAE;IACpE,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,CAAA;IACjC,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;IAC3B,OAAO,IAAI,OAAO,CAAC;QACjB,GAAG;QACH,KAAK,EAAE,IAAI;QACX,MAAM,EAAE,KAAK;QACb,GAAG,EAAE,IAAI;QACT,KAAK,EAAE,KAAK;QACZ,cAAc,EAAE,KAAK;QACrB,QAAQ,EAAE,EAAE;QACZ,MAAM;QACN,QAAQ;QACR,KAAK;KACN,CAAC,CAAA;AACJ,CAAC"}

package/dist/types.d.ts

@@ -6,7 +6,7 @@ export type DbStrategy = 'existing' | 'docker';
 export interface FileWrite {
     path: string;
     contents: string;
-    mode?: 'create' | 'overwrite' | 'patch';
+    mode?: 'create' | 'overwrite' | 'patch' | 'delete';
     before?: string;
 }
 export interface ShellCommand {
@@ -18,7 +18,26 @@ export interface Plan {
     writes: FileWrite[];
     commands: ShellCommand[];
     notes: string[];
+    preconditions?: PlanPrecondition[];
 }
+export interface TreeSnapshotEntry {
+    path: string;
+    type: 'directory' | 'file' | 'other';
+    contents?: string;
+}
+export type PlanPrecondition = {
+    type: 'file';
+    path: string;
+    contents: string | null;
+} | {
+    type: 'tree';
+    path: string;
+    entries: TreeSnapshotEntry[];
+} | {
+    type: 'value';
+    key: string;
+    value: string;
+};
 export interface PhaseResult {
     state: PhaseState;
     notes?: string[];
@@ -38,6 +57,7 @@ export interface Answers {
     dbName?: string;
     dbUser?: string;
     adminPath?: string;
+    signInPath?: string;
     uiDir?: string;
     examples?: boolean;
     importDocs?: boolean;

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAE3C,MAAM,MAAM,OAAO,GACf,WAAW,GACX,SAAS,GACT,MAAM,GACN,IAAI,GACJ,SAAS,GACT,KAAK,GACL,MAAM,GACN,UAAU,GACV,YAAY,GACZ,WAAW,GACX,MAAM,GACN,QAAQ,GACR,IAAI,GACJ,QAAQ,CAAA;AAEZ,MAAM,MAAM,UAAU,GAAG,SAAS,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAA;AAEnE,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,CAAA;AAE5D,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,QAAQ,CAAA;AAE9C,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,QAAQ,GAAG,WAAW,GAAG,OAAO,CAAA;IACvC,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,IAAI;IACnB,MAAM,EAAE,SAAS,EAAE,CAAA;IACnB,QAAQ,EAAE,YAAY,EAAE,CAAA;IACxB,KAAK,EAAE,MAAM,EAAE,CAAA;CAChB;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,UAAU,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;CACjB;AAED,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,OAAO,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,SAAS,GAAG,MAAM,CAAA;IAC/B,MAAM,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IACzC,IAAI,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACjC,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;CACtD;AAED,MAAM,WAAW,OAAO;IACtB,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,EAAE,CAAC,EAAE,cAAc,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,CAAC,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,eAAe,EAAE,OAAO,EAAE,CAAA;IAC1B,OAAO,EAAE,OAAO,CAAA;IAChB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC,CAAA;CACxE"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAE3C,MAAM,MAAM,OAAO,GACf,WAAW,GACX,SAAS,GACT,MAAM,GACN,IAAI,GACJ,SAAS,GACT,KAAK,GACL,MAAM,GACN,UAAU,GACV,YAAY,GACZ,WAAW,GACX,MAAM,GACN,QAAQ,GACR,IAAI,GACJ,QAAQ,CAAA;AAEZ,MAAM,MAAM,UAAU,GAAG,SAAS,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAA;AAEnE,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,CAAA;AAE5D,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,QAAQ,CAAA;AAE9C,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,QAAQ,GAAG,WAAW,GAAG,OAAO,GAAG,QAAQ,CAAA;IAClD,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,IAAI;IACnB,MAAM,EAAE,SAAS,EAAE,CAAA;IACnB,QAAQ,EAAE,YAAY,EAAE,CAAA;IACxB,KAAK,EAAE,MAAM,EAAE,CAAA;IACf,aAAa,CAAC,EAAE,gBAAgB,EAAE,CAAA;CACnC;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,WAAW,GAAG,MAAM,GAAG,OAAO,CAAA;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,MAAM,gBAAgB,GACxB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,GACvD;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,iBAAiB,EAAE,CAAA;CAAE,GAC5D;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAA;AAEjD,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,UAAU,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;CACjB;AAED,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,OAAO,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,SAAS,GAAG,MAAM,CAAA;IAC/B,MAAM,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IACzC,IAAI,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACjC,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;CACtD;AAED,MAAM,WAAW,OAAO;IACtB,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,EAAE,CAAC,EAAE,cAAc,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,CAAC,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,eAAe,EAAE,OAAO,EAAE,CAAA;IAC1B,OAAO,EAAE,OAAO,CAAA;IAChB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC,CAAA;CACxE"}

package/dist/ui-template-contract.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ui-template-contract.test.d.ts.map

package/dist/ui-template-contract.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ui-template-contract.test.d.ts","sourceRoot":"","sources":["../src/ui-template-contract.test.ts"],"names":[],"mappings":""}

package/dist/ui-template-contract.test.js

@@ -0,0 +1,150 @@
+import { dirname, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { ModuleKind, ModuleResolutionKind, Project, ScriptTarget, SyntaxKind } from 'ts-morph';
+import { describe, expect, it } from 'vitest';
+const templates = resolve(dirname(fileURLToPath(import.meta.url)), 'templates');
+const project = new Project({ skipAddingFilesFromTsConfig: true });
+const generated = project.addSourceFileAtPath(resolve(templates, 'byline-examples/generated/collection-types.ts'));
+// Format 2 declares every type inside the `@byline/generated-types`
+// declaration-merge block; alias lookups search the whole file.
+function generatedTypeAliasOrThrow(name) {
+    const alias = generated
+        .getDescendantsOfKind(SyntaxKind.TypeAliasDeclaration)
+        .find((declaration) => declaration.getName() === name);
+    if (!alias)
+        throw new Error(`Expected to find type alias named '${name}'.`);
+    return alias;
+}
+// The plain-module body of the generated types, for in-memory typecheck
+// fixtures: the augmentation block unwrapped to top-level declarations.
+function generatedModuleBody() {
+    const match = generated
+        .getFullText()
+        .match(/declare module '@byline\/generated-types' \{\n([\s\S]*?)\n\}\n\ndeclare module/);
+    if (!match?.[1])
+        throw new Error('Expected a @byline/generated-types augmentation block.');
+    return match[1].replace(/^ {2}/gm, '');
+}
+const contentTypes = project.addSourceFileAtPath(resolve(templates, 'ui-byline/types/content.ts'));
+const renderer = project.addSourceFileAtPath(resolve(templates, 'ui-byline/render-blocks.tsx'));
+describe('public block renderer templates', () => {
+    it('covers every generated Docs and Pages block discriminant', () => {
+        const blockNames = new Set([
+            ...contentBlockNames('DocsFields'),
+            ...contentBlockNames('PagesFields'),
+        ]);
+        const expectedTypes = [...blockNames].map(blockDiscriminant).sort();
+        const switchStatement = renderer
+            .getDescendantsOfKind(SyntaxKind.SwitchStatement)
+            .find((node) => node.getExpression().getText() === 'block._type');
+        const renderedTypes = switchStatement
+            ?.getCaseBlock()
+            .getClauses()
+            .flatMap((clause) => {
+            if (!clause.isKind(SyntaxKind.CaseClause))
+                return [];
+            const expression = clause.getExpression();
+            return expression.isKind(SyntaxKind.StringLiteral) ? [expression.getLiteralValue()] : [];
+        })
+            .sort();
+        expect(renderedTypes).toEqual(expectedTypes);
+    });
+    it('combines both consumers and preserves consumer-specific content in the overlay', () => {
+        expect(contentTypes.getTypeAliasOrThrow('ContentBlock').getTypeNodeOrThrow().getText()).toBe('ContentBlockOf<DocsFields> | ContentBlockOf<PagesFields>');
+        expect(contentTypes.getTypeAlias('WithPopulatedPhotoBlockContent')).toBeDefined();
+    });
+    it('typechecks the populated union and consumer-specific overlay contract', () => {
+        const typeProject = new Project({
+            useInMemoryFileSystem: true,
+            compilerOptions: {
+                strict: true,
+                noEmit: true,
+                module: ModuleKind.ESNext,
+                moduleResolution: ModuleResolutionKind.Bundler,
+                target: ScriptTarget.ES2024,
+            },
+        });
+        typeProject.createSourceFile('/client.ts', `
+        export interface PopulatedRelation<T> { document?: T }
+        export type WithPopulated<F, K extends keyof F, Target> = {
+          [P in keyof F]: P extends K ? PopulatedRelation<Target> : F[P]
+        }
+      `);
+        typeProject.createSourceFile('/generated.ts', `type JsonValue = unknown
+       type RelatedDocumentValue = { documentId: string }
+       type StoredFileValue = { key: string }
+       ${generatedModuleBody()}`);
+        typeProject.createSourceFile('/content.ts', contentTypes
+            .getFullText()
+            .replace("from '@byline/client'", "from './client.js'")
+            .replace("from '@byline/generated-types'", "from './generated.js'"));
+        typeProject.createSourceFile('/contract.ts', `
+        import type { WithPopulated } from './client.js'
+        import type { DocsFields, MediaFields, PagesFields } from './generated.js'
+        import type {
+          PopulatedContentBlock,
+          WithPopulatedPhotoBlockContent,
+        } from './content.js'
+
+        type Equal<Left, Right> =
+          (<Value>() => Value extends Left ? 1 : 2) extends
+          (<Value>() => Value extends Right ? 1 : 2) ? true : false
+        type Assert<Value extends true> = Value
+        type ConsumerBlock =
+          | NonNullable<DocsFields['content']>[number]
+          | NonNullable<PagesFields['content']>[number]
+        type PhotoBlock = Extract<ConsumerBlock, { _type: 'photoBlock' }>
+        type ExpectedBlock =
+          | Exclude<ConsumerBlock, PhotoBlock>
+          | WithPopulated<PhotoBlock, 'photo', MediaFields>
+        type PagesOnlyBlock = { _id: string; _type: 'pagesOnlyBlock'; heading: string }
+        type ExtendedPages = Omit<PagesFields, 'content'> & {
+          content?: Array<NonNullable<PagesFields['content']>[number] | PagesOnlyBlock>
+        }
+        type PopulatedExtendedBlock = NonNullable<
+          WithPopulatedPhotoBlockContent<ExtendedPages>['content']
+        >[number]
+
+        type PopulatedUnionContract = Assert<Equal<PopulatedContentBlock, ExpectedBlock>>
+        type ConsumerOverlayContract = Assert<
+          Equal<Extract<PopulatedExtendedBlock, { _type: 'pagesOnlyBlock' }>, PagesOnlyBlock>
+        >
+      `);
+        expect(typeProject.getPreEmitDiagnostics().map((diagnostic) => diagnostic.getMessageText())).toEqual([]);
+    });
+    it('reports unsupported runtime blocks and returns null', () => {
+        const fallback = renderer.getFunctionOrThrow('reportUnsupportedBlock');
+        expect(fallback
+            .getDescendantsOfKind(SyntaxKind.CallExpression)
+            .some((call) => call.getExpression().getText() === 'console.error')).toBe(true);
+        expect(fallback
+            .getDescendantsOfKind(SyntaxKind.ReturnStatement)
+            .some((statement) => statement.getExpression()?.isKind(SyntaxKind.NullKeyword))).toBe(true);
+    });
+});
+function contentBlockNames(collection) {
+    const content = generatedTypeAliasOrThrow(collection)
+        .getDescendantsOfKind(SyntaxKind.PropertySignature)
+        .find((property) => property.getName() === 'content');
+    const matches = content
+        ?.getTypeNodeOrThrow()
+        .getText()
+        .matchAll(/\b([A-Z]\w*BlockData)\b/g);
+    return [...(matches ?? [])].map((match) => match[1]).filter((name) => name !== undefined);
+}
+function blockDiscriminant(blockName) {
+    const type = generatedTypeAliasOrThrow(blockName);
+    const discriminant = type
+        .getDescendantsOfKind(SyntaxKind.PropertySignature)
+        .find((property) => property.getName() === '_type')
+        ?.getTypeNodeOrThrow();
+    if (!discriminant?.isKind(SyntaxKind.LiteralType)) {
+        throw new Error(`Generated block ${blockName} has no literal _type`);
+    }
+    const literal = discriminant.getLiteral();
+    if (!literal.isKind(SyntaxKind.StringLiteral)) {
+        throw new Error(`Generated block ${blockName} has a non-string _type`);
+    }
+    return literal.getLiteralValue();
+}
+//# sourceMappingURL=ui-template-contract.test.js.map

package/dist/ui-template-contract.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ui-template-contract.test.js","sourceRoot":"","sources":["../src/ui-template-contract.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAE,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAC9F,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAA;AAE7C,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,WAAW,CAAC,CAAA;AAC/E,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,EAAE,2BAA2B,EAAE,IAAI,EAAE,CAAC,CAAA;AAClE,MAAM,SAAS,GAAG,OAAO,CAAC,mBAAmB,CAC3C,OAAO,CAAC,SAAS,EAAE,+CAA+C,CAAC,CACpE,CAAA;AACD,oEAAoE;AACpE,gEAAgE;AAChE,SAAS,yBAAyB,CAAC,IAAY;IAC7C,MAAM,KAAK,GAAG,SAAS;SACpB,oBAAoB,CAAC,UAAU,CAAC,oBAAoB,CAAC;SACrD,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,IAAI,CAAC,CAAA;IACxD,IAAI,CAAC,KAAK;QAAE,MAAM,IAAI,KAAK,CAAC,sCAAsC,IAAI,IAAI,CAAC,CAAA;IAC3E,OAAO,KAAK,CAAA;AACd,CAAC;AACD,wEAAwE;AACxE,wEAAwE;AACxE,SAAS,mBAAmB;IAC1B,MAAM,KAAK,GAAG,SAAS;SACpB,WAAW,EAAE;SACb,KAAK,CAAC,gFAAgF,CAAC,CAAA;IAC1F,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAA;IAC1F,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAA;AACxC,CAAC;AACD,MAAM,YAAY,GAAG,OAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC,SAAS,EAAE,4BAA4B,CAAC,CAAC,CAAA;AAClG,MAAM,QAAQ,GAAG,OAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC,SAAS,EAAE,6BAA6B,CAAC,CAAC,CAAA;AAE/F,QAAQ,CAAC,iCAAiC,EAAE,GAAG,EAAE;IAC/C,EAAE,CAAC,0DAA0D,EAAE,GAAG,EAAE;QAClE,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC;YACzB,GAAG,iBAAiB,CAAC,YAAY,CAAC;YAClC,GAAG,iBAAiB,CAAC,aAAa,CAAC;SACpC,CAAC,CAAA;QACF,MAAM,aAAa,GAAG,CAAC,GAAG,UAAU,CAAC,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,IAAI,EAAE,CAAA;QACnE,MAAM,eAAe,GAAG,QAAQ;aAC7B,oBAAoB,CAAC,UAAU,CAAC,eAAe,CAAC;aAChD,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,OAAO,EAAE,KAAK,aAAa,CAAC,CAAA;QACnE,MAAM,aAAa,GAAG,eAAe;YACnC,EAAE,YAAY,EAAE;aACf,UAAU,EAAE;aACZ,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YAClB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC;gBAAE,OAAO,EAAE,CAAA;YACpD,MAAM,UAAU,GAAG,MAAM,CAAC,aAAa,EAAE,CAAA;YACzC,OAAO,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;QAC1F,CAAC,CAAC;aACD,IAAI,EAAE,CAAA;QAET,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAA;IAC9C,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,gFAAgF,EAAE,GAAG,EAAE;QACxF,MAAM,CAAC,YAAY,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC,kBAAkB,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAC1F,0DAA0D,CAC3D,CAAA;QACD,MAAM,CAAC,YAAY,CAAC,YAAY,CAAC,gCAAgC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAA;IACnF,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,uEAAuE,EAAE,GAAG,EAAE;QAC/E,MAAM,WAAW,GAAG,IAAI,OAAO,CAAC;YAC9B,qBAAqB,EAAE,IAAI;YAC3B,eAAe,EAAE;gBACf,MAAM,EAAE,IAAI;gBACZ,MAAM,EAAE,IAAI;gBACZ,MAAM,EAAE,UAAU,CAAC,MAAM;gBACzB,gBAAgB,EAAE,oBAAoB,CAAC,OAAO;gBAC9C,MAAM,EAAE,YAAY,CAAC,MAAM;aAC5B;SACF,CAAC,CAAA;QACF,WAAW,CAAC,gBAAgB,CAC1B,YAAY,EACZ;;;;;OAKC,CACF,CAAA;QACD,WAAW,CAAC,gBAAgB,CAC1B,eAAe,EACf;;;SAGG,mBAAmB,EAAE,EAAE,CAC3B,CAAA;QACD,WAAW,CAAC,gBAAgB,CAC1B,aAAa,EACb,YAAY;aACT,WAAW,EAAE;aACb,OAAO,CAAC,uBAAuB,EAAE,oBAAoB,CAAC;aACtD,OAAO,CAAC,gCAAgC,EAAE,uBAAuB,CAAC,CACtE,CAAA;QACD,WAAW,CAAC,gBAAgB,CAC1B,cAAc,EACd;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BC,CACF,CAAA;QAED,MAAM,CACJ,WAAW,CAAC,qBAAqB,EAAE,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CACrF,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IACf,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;QAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,kBAAkB,CAAC,wBAAwB,CAAC,CAAA;QAEtE,MAAM,CACJ,QAAQ;aACL,oBAAoB,CAAC,UAAU,CAAC,cAAc,CAAC;aAC/C,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,OAAO,EAAE,KAAK,eAAe,CAAC,CACtE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACZ,MAAM,CACJ,QAAQ;aACL,oBAAoB,CAAC,UAAU,CAAC,eAAe,CAAC;aAChD,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,aAAa,EAAE,EAAE,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAClF,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACd,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA;AAEF,SAAS,iBAAiB,CAAC,UAAwC;IACjE,MAAM,OAAO,GAAG,yBAAyB,CAAC,UAAU,CAAC;SAClD,oBAAoB,CAAC,UAAU,CAAC,iBAAiB,CAAC;SAClD,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,EAAE,KAAK,SAAS,CAAC,CAAA;IACvD,MAAM,OAAO,GAAG,OAAO;QACrB,EAAE,kBAAkB,EAAE;SACrB,OAAO,EAAE;SACT,QAAQ,CAAC,0BAA0B,CAAC,CAAA;IAEvC,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAA;AAC3F,CAAC;AAED,SAAS,iBAAiB,CAAC,SAAiB;IAC1C,MAAM,IAAI,GAAG,yBAAyB,CAAC,SAAS,CAAC,CAAA;IACjD,MAAM,YAAY,GAAG,IAAI;SACtB,oBAAoB,CAAC,UAAU,CAAC,iBAAiB,CAAC;SAClD,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,EAAE,KAAK,OAAO,CAAC;QACnD,EAAE,kBAAkB,EAAE,CAAA;IAExB,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;QAClD,MAAM,IAAI,KAAK,CAAC,mBAAmB,SAAS,uBAAuB,CAAC,CAAA;IACtE,CAAC;IACD,MAAM,OAAO,GAAG,YAAY,CAAC,UAAU,EAAE,CAAA;IACzC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;QAC9C,MAAM,IAAI,KAAK,CAAC,mBAAmB,SAAS,yBAAyB,CAAC,CAAA;IACxE,CAAC;IACD,OAAO,OAAO,CAAC,eAAe,EAAE,CAAA;AAClC,CAAC"}

package/dist/workspace-root.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=workspace-root.test.d.ts.map

package/dist/workspace-root.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workspace-root.test.d.ts","sourceRoot":"","sources":["../src/workspace-root.test.ts"],"names":[],"mappings":""}