@bendyline/squisq 0.1.2 → 1.1.0

package/src/__tests__/slideshowGenerator.test.ts

@@ -0,0 +1,128 @@
+import { describe, expect, it } from 'vitest';
+import { generateSlideshow, type SlideshowImage } from '../generate/index.js';
+import { isTemplateBlock } from '../schemas/BlockTemplates.js';
+
+const ARTICLE_TEXT = [
+  'Mount Rainier is the largest volcano in the Cascades, standing at 14,411 feet.',
+  'In July 1899, President McKinley signed the act establishing Mount Rainier National Park.',
+  'The park encompasses roughly 236,381 acres of old-growth forest and alpine meadows.',
+  '"The mountain was calling me," wrote John Muir after his 1888 expedition to explore the glaciers.',
+  'Temperatures range from 20 degrees to 70 degrees depending on elevation and season.',
+  'Popular activities including hiking, camping, fishing, and climbing draw visitors year-round.',
+  'Paradise is a popular visitor area known for its wildflower meadows and spectacular views.',
+  'The mountain has 25 named glaciers covering about 35 square miles of ice.',
+  'Rainier is the most glaciated peak in the lower 48 states, a remarkable natural wonder.',
+  'Imagine standing above the clouds at sunrise!',
+].join('\n\n');
+
+const SAMPLE_IMAGES: SlideshowImage[] = [
+  { src: '/img/rainier-1.jpg', alt: 'Mount Rainier from Paradise' },
+  { src: '/img/rainier-2.jpg', alt: 'Wildflower meadow', credit: 'NPS Photo' },
+  { src: '/img/rainier-3.jpg', alt: 'Nisqually Glacier' },
+];
+
+describe('generateSlideshow', () => {
+  it('produces a valid Doc with blocks', () => {
+    const doc = generateSlideshow(ARTICLE_TEXT);
+    expect(doc.blocks.length).toBeGreaterThan(0);
+    expect(doc.duration).toBeGreaterThan(0);
+    expect(doc.articleId).toBe('slideshow');
+  });
+
+  it('includes a title slide when title is provided', () => {
+    const doc = generateSlideshow(ARTICLE_TEXT, [], { title: 'Mount Rainier' });
+    expect(doc.articleId).toBe('Mount Rainier');
+    const first = doc.blocks[0];
+    if (isTemplateBlock(first)) {
+      expect(first.template).toBe('titleBlock');
+    }
+  });
+
+  it('embeds themeId in the Doc', () => {
+    const doc = generateSlideshow(ARTICLE_TEXT, [], { themeId: 'cinematic' });
+    expect(doc.themeId).toBe('cinematic');
+  });
+
+  it('interleaves image slides when images are provided', () => {
+    const doc = generateSlideshow(ARTICLE_TEXT, SAMPLE_IMAGES);
+    const imageSlides = doc.blocks.filter(
+      (b) => isTemplateBlock(b) && b.template === 'imageWithCaption',
+    );
+    expect(imageSlides.length).toBeGreaterThan(0);
+  });
+
+  it('produces deterministic output with the same seed', () => {
+    const a = generateSlideshow(ARTICLE_TEXT, SAMPLE_IMAGES, { seed: 42 });
+    const b = generateSlideshow(ARTICLE_TEXT, SAMPLE_IMAGES, { seed: 42 });
+    expect(a.blocks.length).toBe(b.blocks.length);
+    for (let i = 0; i < a.blocks.length; i++) {
+      if (isTemplateBlock(a.blocks[i]) && isTemplateBlock(b.blocks[i])) {
+        const aBlock = a.blocks[i] as { template: string };
+        const bBlock = b.blocks[i] as { template: string };
+        expect(aBlock.template).toBe(bBlock.template);
+      }
+    }
+  });
+
+  it('produces different output with different seeds', () => {
+    const a = generateSlideshow(ARTICLE_TEXT, SAMPLE_IMAGES, { seed: 1 });
+    const b = generateSlideshow(ARTICLE_TEXT, SAMPLE_IMAGES, { seed: 999 });
+    // At least some image accents or motions should differ
+    const aSerialized = JSON.stringify(a.blocks);
+    const bSerialized = JSON.stringify(b.blocks);
+    // They should differ in at least some detail (ambient motions, accent positions)
+    expect(aSerialized).not.toBe(bSerialized);
+  });
+
+  it('handles empty text gracefully', () => {
+    const doc = generateSlideshow('', []);
+    expect(doc.blocks.length).toBe(0);
+    expect(doc.duration).toBe(0);
+  });
+
+  it('handles markdown input when isMarkdown is set', () => {
+    const md = '# Title\n\nThe park covers **236,381 acres** of wilderness.';
+    const doc = generateSlideshow(md, [], { isMarkdown: true });
+    expect(doc.blocks.length).toBeGreaterThan(0);
+  });
+
+  it('uses explicit duration when provided', () => {
+    const doc = generateSlideshow(ARTICLE_TEXT, [], { duration: 60 });
+    expect(doc.duration).toBe(60);
+  });
+
+  it('respects targetSlides option', () => {
+    const doc = generateSlideshow(ARTICLE_TEXT, [], { targetSlides: 3 });
+    // Should have ~3 slides (may be slightly more due to title, images)
+    expect(doc.blocks.length).toBeLessThanOrEqual(5);
+    expect(doc.blocks.length).toBeGreaterThan(0);
+  });
+
+  it('every block has an id and duration', () => {
+    const doc = generateSlideshow(ARTICLE_TEXT, SAMPLE_IMAGES, { title: 'Test' });
+    for (const block of doc.blocks) {
+      if (isTemplateBlock(block)) {
+        expect(block.id).toBeTruthy();
+        expect(block.duration).toBeGreaterThan(0);
+      }
+    }
+  });
+
+  it('rotates color schemes across content slides', () => {
+    const doc = generateSlideshow(ARTICLE_TEXT, [], {
+      colorSchemes: ['blue', 'green'],
+      targetSlides: 6,
+    });
+    const colors: string[] = [];
+    for (const block of doc.blocks) {
+      if (isTemplateBlock(block) && 'colorScheme' in block) {
+        const cs = (block as { colorScheme?: string }).colorScheme;
+        if (cs) colors.push(cs);
+      }
+    }
+    // With 2 schemes, we should see alternation
+    if (colors.length >= 2) {
+      expect(colors[0]).not.toBe(colors[1]);
+    }
+  });
+});

package/src/__tests__/timing.test.ts

@@ -0,0 +1,167 @@
+import { describe, expect, it } from 'vitest';
+import {
+  countSpokenWords,
+  estimateSpokenWordCount,
+  estimateTimeFromText,
+  calculatePrefixDuration,
+  estimateNarrationDuration,
+  estimateReadingTime,
+  estimateNarrationTime,
+  DEFAULT_WORDS_PER_SECOND,
+} from '../timing/index.js';
+
+// ── narrationTiming ────────────────────────────────────────────────
+
+describe('estimateSpokenWordCount', () => {
+  it('counts a regular word as 1', () => {
+    expect(estimateSpokenWordCount('hello')).toBe(1);
+  });
+
+  it('expands a small number (50 → "fifty" → 1 word × 1.3)', () => {
+    expect(estimateSpokenWordCount('50')).toBeCloseTo(1.3);
+  });
+
+  it('expands a year (1910 → "nineteen ten" → 2 × 1.3)', () => {
+    expect(estimateSpokenWordCount('1910')).toBeCloseTo(2.6);
+  });
+
+  it('expands a large number (175000)', () => {
+    // "one hundred seventy-five" (4 words) + "thousand" (1) = 5 words × 1.3
+    expect(estimateSpokenWordCount('175000')).toBeCloseTo(6.5, 1);
+  });
+
+  it('handles 2024 as a year', () => {
+    // "twenty twenty-four" → 3 words × 1.3
+    expect(estimateSpokenWordCount('2024')).toBeCloseTo(3.9);
+  });
+
+  it('handles zero', () => {
+    // "zero" → 1 word × 1.3
+    expect(estimateSpokenWordCount('0')).toBeCloseTo(1.3);
+  });
+
+  it('handles non-numeric strings', () => {
+    expect(estimateSpokenWordCount('hello')).toBe(1);
+    expect(estimateSpokenWordCount('')).toBe(1);
+  });
+});
+
+describe('countSpokenWords', () => {
+  it('counts plain text words', () => {
+    expect(countSpokenWords('the quick brown fox')).toBe(4);
+  });
+
+  it('includes comma pause penalties', () => {
+    const withComma = countSpokenWords('hello, world');
+    const without = countSpokenWords('hello world');
+    expect(withComma).toBeGreaterThan(without);
+    expect(withComma - without).toBeCloseTo(0.3);
+  });
+
+  it('expands numbers within text', () => {
+    const result = countSpokenWords('In 1910 there were 50 houses');
+    // "In"(1) + "1910"(2.6) + "there"(1) + "were"(1) + "50"(1.3) + "houses"(1)
+    expect(result).toBeCloseTo(7.9);
+  });
+
+  it('returns 0 for empty text', () => {
+    expect(countSpokenWords('')).toBe(0);
+  });
+});
+
+describe('estimateTimeFromText', () => {
+  it('returns 0 at the beginning', () => {
+    expect(estimateTimeFromText('hello world', 0, 10)).toBe(0);
+  });
+
+  it('returns proportional time at the midpoint', () => {
+    const time = estimateTimeFromText('one two three four', 8, 20);
+    // "one two" = 2 words before offset 8, total = 4 words → 50% → 10s
+    expect(time).toBeCloseTo(10);
+  });
+
+  it('returns totalDuration at the end', () => {
+    const text = 'some text here';
+    const time = estimateTimeFromText(text, text.length, 30);
+    expect(time).toBeCloseTo(30);
+  });
+
+  it('returns 0 for empty text', () => {
+    expect(estimateTimeFromText('', 0, 10)).toBe(0);
+  });
+});
+
+describe('calculatePrefixDuration', () => {
+  it('returns 0 for empty string', () => {
+    expect(calculatePrefixDuration('')).toBe(0);
+  });
+
+  it('estimates based on word count', () => {
+    // 5 words at 2.5 wps = 2 seconds
+    expect(calculatePrefixDuration('one two three four five')).toBeCloseTo(2);
+  });
+
+  it('adds pause time for paragraph breaks', () => {
+    const withBreak = calculatePrefixDuration('Title\n\nContent here');
+    const without = calculatePrefixDuration('Title Content here');
+    expect(withBreak).toBeGreaterThan(without);
+    // One paragraph break → +0.5s
+    expect(withBreak - without).toBeCloseTo(0.5);
+  });
+});
+
+describe('estimateNarrationDuration', () => {
+  it('estimates simple text', () => {
+    // 5 words at 2.5 wps = 2 seconds
+    expect(estimateNarrationDuration('one two three four five')).toBeCloseTo(2);
+  });
+
+  it('accepts custom rate', () => {
+    // 5 words at 5 wps = 1 second
+    expect(estimateNarrationDuration('one two three four five', 5)).toBeCloseTo(1);
+  });
+});
+
+// ── readingTime ────────────────────────────────────────────────────
+
+describe('estimateReadingTime', () => {
+  it('estimates 200-word text at 1 minute', () => {
+    const text = Array(200).fill('word').join(' ');
+    const result = estimateReadingTime(text);
+    expect(result.words).toBe(200);
+    expect(result.minutes).toBeCloseTo(1);
+    expect(result.seconds).toBe(60);
+  });
+
+  it('respects custom WPM', () => {
+    const text = Array(100).fill('word').join(' ');
+    const result = estimateReadingTime(text, { wordsPerMinute: 100 });
+    expect(result.minutes).toBeCloseTo(1);
+  });
+
+  it('returns 0 for empty text', () => {
+    const result = estimateReadingTime('');
+    expect(result.words).toBe(0);
+    expect(result.seconds).toBe(0);
+  });
+});
+
+describe('estimateNarrationTime', () => {
+  it('accounts for number expansion', () => {
+    const plain = estimateNarrationTime('five words in this text');
+    const withNum = estimateNarrationTime('In 1910 there were 50 houses');
+    // Numbers add more spoken-word equivalents
+    expect(withNum.spokenWords).toBeGreaterThan(plain.spokenWords);
+  });
+
+  it('returns reasonable seconds', () => {
+    const result = estimateNarrationTime('one two three four five');
+    expect(result.seconds).toBe(2); // 5 words / 2.5 wps = 2s
+  });
+});
+
+describe('DEFAULT_WORDS_PER_SECOND', () => {
+  it('is 2.5', () => {
+    expect(DEFAULT_WORDS_PER_SECOND).toBe(2.5);
+  });
+});