lyrics-structure 1.0.2 → 1.0.4

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Splits text into parts based on bracketed content while maintaining its structure.
+ * Does not consider line length or formatting.
+ *
+ * @param text - The input text to be split into parts
+ * @returns An array of content strings
+ */
+export declare const getParts: (text?: string) => string[];
+/**
+ * Splits text into natural sections based on text structure.
+ * Works with plain text without requiring markdown or special formatting.
+ *
+ * @param text - The input text to be split into sections
+ * @param maxLinesPerSlide - Maximum number of lines to include in a single slide (default: 6)
+ * @returns An array of content sections
+ */
+export declare const getSlideParts: (text?: string, maxLinesPerSlide?: number) => string[];

package/dist/index.js

@@ -0,0 +1,131 @@
+/**
+ * Splits text into parts based on bracketed content while maintaining its structure.
+ * Does not consider line length or formatting.
+ *
+ * @param text - The input text to be split into parts
+ * @returns An array of content strings
+ */
+export const getParts = (text) => {
+    if (!text)
+        return [];
+    // Process parts in brackets and create a map
+    const partsMap = new Map();
+    // First pass: extract all content with closing tags
+    const cleanedText = text.replace(/\[(.*?)\]([\s\S]*?)\[\/\1\]/g, (match, key, content) => {
+        if (!partsMap.has(key)) {
+            partsMap.set(key, content.trim());
+        }
+        return `[${key}]`;
+    });
+    // Second pass: handle validation and solo tags that should reuse content
+    const processedText = cleanedText.replace(/\[([^\]]+)\](?!\s*\[\/)(?!\s*\])/g, // Match tags that don't have a closing tag after them
+    (match, key) => {
+        if (partsMap.has(key)) {
+            return match; // Keep the reference if we already have content for this key
+        }
+        else {
+            console.warn(`Warning: Tag [${key}] has no content and was not previously defined`);
+            return ''; // Remove invalid tags
+        }
+    });
+    const result = [];
+    const parts = processedText
+        .trim()
+        .split(/\[([^\]]+)\]/)
+        .filter(Boolean);
+    parts.forEach((part) => {
+        if (partsMap.has(part)) {
+            // Add the stored part content
+            result.push(partsMap.get(part));
+        }
+        else if (part.trim()) {
+            // Add non-bracketed content
+            result.push(part.trim());
+        }
+    });
+    return result;
+};
+/**
+ * Splits text into natural sections based on text structure.
+ * Works with plain text without requiring markdown or special formatting.
+ *
+ * @param text - The input text to be split into sections
+ * @param maxLinesPerSlide - Maximum number of lines to include in a single slide (default: 6)
+ * @returns An array of content sections
+ */
+export const getSlideParts = (text, maxLinesPerSlide = 6) => {
+    if (!text)
+        return [];
+    // Extract bracketed content first
+    const basicParts = getParts(text);
+    const result = [];
+    basicParts.forEach(part => {
+        // Check if content has line breaks that should be respected
+        const lines = part.split('\n').filter(line => line.trim().length > 0);
+        // If we have multiple lines and more than maxLinesPerSlide, create slides based on line count
+        if (lines.length > 1) {
+            if (lines.length > maxLinesPerSlide) {
+                // Break into multiple slides based on maxLinesPerSlide
+                let currentSlide = [];
+                lines.forEach(line => {
+                    if (currentSlide.length >= maxLinesPerSlide) {
+                        result.push(currentSlide.join('\n'));
+                        currentSlide = [];
+                    }
+                    currentSlide.push(line);
+                });
+                // Add the final slide if it exists
+                if (currentSlide.length > 0) {
+                    result.push(currentSlide.join('\n'));
+                }
+            }
+            else {
+                // Split by natural paragraph breaks (empty lines)
+                const paragraphs = part.split(/\n\s*\n/)
+                    .filter(p => p.trim().length > 0)
+                    .map(p => p.trim());
+                // If we have multiple paragraphs, use those as natural breaks
+                if (paragraphs.length > 1) {
+                    result.push(...paragraphs);
+                }
+                else {
+                    // Just use the whole part as a single slide
+                    result.push(part);
+                }
+            }
+        }
+        else {
+            // For single large paragraphs (no line breaks), try to find natural sentence groups
+            const sentences = part.split(/(?<=[.!?])\s+/)
+                .filter(s => s.trim().length > 0);
+            // Group sentences into reasonable chunks
+            const sentenceGroups = [];
+            let currentGroup = [];
+            let currentLength = 0;
+            sentences.forEach(sentence => {
+                // Natural breakpoint based on content and length
+                // Group 3-5 sentences together or until we reach ~300 chars
+                if (currentGroup.length >= 4 || currentLength > 250) {
+                    sentenceGroups.push(currentGroup.join(' '));
+                    currentGroup = [];
+                    currentLength = 0;
+                }
+                currentGroup.push(sentence);
+                currentLength += sentence.length;
+            });
+            // Add the last group if it exists
+            if (currentGroup.length > 0) {
+                sentenceGroups.push(currentGroup.join(' '));
+            }
+            // If we created multiple groups, use them
+            if (sentenceGroups.length > 1) {
+                result.push(...sentenceGroups);
+            }
+            else {
+                // Otherwise just use the whole part
+                result.push(part);
+            }
+        }
+    });
+    return result;
+};

package/dist/test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test.js

@@ -0,0 +1,155 @@
+import * as assert from 'assert';
+import { getParts, getSlideParts } from './index.js';
+// Test data
+const lyricsSample = `
+[verse1]
+I still hear your voice when you sleep next to me
+I still feel your touch in my dreams
+Forgive me my weakness, but I don't know why
+Without you it's hard to survive
+[/verse1]
+
+[chorus]
+'Cause every time we touch, I get this feeling
+And every time we kiss, I swear I could fly
+Can't you feel my heart beat fast?
+I want this to last
+Need you by my side
+[/chorus]
+
+[verse2]
+Your arms are my castle, your heart is my sky
+They wipe away tears that I cry
+The good and the bad times, we've been through them all
+You make me rise when I fall
+[/verse2]
+
+[chorus]
+`;
+const bibleSample = `
+In the beginning God created the heavens and the earth. Now the earth was formless and empty, darkness was over the surface of the deep, and the Spirit of God was hovering over the waters.
+
+And God said, "Let there be light," and there was light. God saw that the light was good, and he separated the light from the darkness. God called the light "day," and the darkness he called "night." And there was evening, and there was morning—the first day.
+
+[psalm23]
+The LORD is my shepherd, I lack nothing. 
+He makes me lie down in green pastures, 
+he leads me beside quiet waters, 
+he refreshes my soul.
+[/psalm23]
+
+five
+short
+lines
+should
+be one slide
+
+very long line that should be split into two lines but has been sent on one line intead
+`;
+console.log('Running tests for text processing functions...');
+// Test getParts with lyrics
+console.log('\n----- Testing getParts with lyrics -----');
+const lyricsParts = getParts(lyricsSample);
+console.log(`Found ${lyricsParts.length} parts`);
+lyricsParts.forEach((part, i) => {
+    console.log(`\nPart ${i + 1}:`);
+    console.log(part);
+});
+assert.strictEqual(lyricsParts.length, 4, 'Should extract 4 parts from lyrics (verse1, chorus, verse2, repeated chorus)');
+// Test that the repeated chorus matches the original chorus
+const chorusContent = lyricsParts[1]; // First chorus (index 1)
+const repeatedChorus = lyricsParts[3]; // Last part (index 3) should be repeated chorus
+console.log('\nVerifying repeated chorus:');
+console.log(`Original chorus: "${chorusContent.substring(0, 20)}..."`);
+console.log(`Repeated chorus: "${repeatedChorus.substring(0, 20)}..."`);
+assert.strictEqual(repeatedChorus, chorusContent, 'Repeated chorus should match the original chorus content');
+// Test getParts with Bible verses
+console.log('\n----- Testing getParts with Bible verses -----');
+const bibleParts = getParts(bibleSample);
+console.log(`Found ${bibleParts.length} parts`);
+bibleParts.forEach((part, i) => {
+    console.log(`\nPart ${i + 1}:`);
+    console.log(part);
+});
+assert.strictEqual(bibleParts.length, 3, 'Should extract 3 parts from Bible verses (main text, psalm23, and the "five short lines" section)');
+// Test getSlideParts with lyrics
+console.log('\n----- Testing getSlideParts with lyrics -----');
+const lyricsSlides = getSlideParts(lyricsSample);
+console.log(`Found ${lyricsSlides.length} slides`);
+lyricsSlides.forEach((slide, i) => {
+    console.log(`\nSlide ${i + 1}:`);
+    console.log(slide);
+});
+// This should now include the repeated chorus
+assert.strictEqual(lyricsSlides.length, 4, 'Should have 4 slides including the repeated chorus');
+// Test getSlideParts with Bible verses (default maxLinesPerSlide: 6)
+console.log('\n----- Testing getSlideParts with Bible verses (default maxLinesPerSlide) -----');
+const bibleSlides = getSlideParts(bibleSample);
+console.log(`Found ${bibleSlides.length} slides`);
+bibleSlides.forEach((slide, i) => {
+    console.log(`\nSlide ${i + 1} (${slide.length} characters):`);
+    console.log('-'.repeat(40));
+    console.log(slide);
+    console.log('-'.repeat(40));
+});
+// Test getSlideParts with Bible verses and custom maxLinesPerSlide = 2
+console.log('\n----- Testing getSlideParts with Bible verses (maxLinesPerSlide: 2) -----');
+const bibleSlidesTighter = getSlideParts(bibleSample, 2);
+console.log(`Found ${bibleSlidesTighter.length} slides (with maxLinesPerSlide: 2)`);
+bibleSlidesTighter.forEach((slide, i) => {
+    console.log(`\nSlide ${i + 1} (${slide.length} characters):`);
+    console.log('-'.repeat(40));
+    console.log(slide);
+    console.log('-'.repeat(40));
+});
+// Test handling of long lines that need to be split
+console.log('\n----- Testing getSlideParts with long lines -----');
+const longLineText = `
+This is a normal line.
+This is another normal line.
+very long line that should be split into two lines but has been sent on one line instead and should be handled properly by the getSlideParts function for better readability
+Last normal line.
+`;
+const longLineSlides = getSlideParts(longLineText);
+console.log(`Found ${longLineSlides.length} slides for long line text`);
+longLineSlides.forEach((slide, i) => {
+    console.log(`\nSlide ${i + 1}:`);
+    console.log('-'.repeat(40));
+    console.log(slide);
+    console.log('-'.repeat(40));
+});
+// Test edge cases
+console.log('\n----- Testing edge cases -----');
+// Empty string
+const emptyResult = getSlideParts('');
+console.log(`Empty string produced ${emptyResult.length} slides`);
+assert.strictEqual(emptyResult.length, 0, 'Empty string should produce 0 slides');
+// Single line
+const singleLineResult = getSlideParts('Just one line');
+console.log(`Single line produced ${singleLineResult.length} slides`);
+console.log(singleLineResult[0]);
+assert.strictEqual(singleLineResult.length, 1, 'Single line should produce 1 slide');
+assert.strictEqual(singleLineResult[0], 'Just one line', 'Content should match input');
+// Nested tags
+const nestedTagsText = `
+[outer]
+Some text
+[inner]
+Nested content
+[/inner]
+More outer text
+[/outer]
+`;
+const nestedParts = getParts(nestedTagsText);
+console.log('\nNested tags test:');
+console.log(`Found ${nestedParts.length} parts`);
+nestedParts.forEach((part, i) => {
+    console.log(`Part ${i + 1}: ${part}`);
+});
+// Test with maxLinesPerSlide = 1 (extreme case)
+console.log('\n----- Testing with maxLinesPerSlide = 1 -----');
+const extremeSlides = getSlideParts(bibleSample, 1);
+console.log(`Found ${extremeSlides.length} slides with maxLinesPerSlide = 1`);
+assert.ok(extremeSlides.length > bibleSlides.length, 'Setting maxLinesPerSlide = 1 should produce more slides');
+console.log('\nAll tests completed successfully!');
+console.log('\nAll additional tests completed successfully!');

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "lyrics-structure",
-  "version": "1.0.2",
-  "main": "index.js",
+  "version": "1.0.4",
+  "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
-    "test": "npx ts-node test.ts",
+    "test": "node dist/test.js",
     "build": "tsc"
   },
   "keywords": [],
   "author": "",
   "license": "ISC",
-  "type": "commonjs",
+  "type": "module",
   "description": "",
   "devDependencies": {
     "@types/node": "^22.13.10",

package/{test.ts → test.js}

@@ -1,5 +1,5 @@
 import * as assert from 'assert';
-import { getParts, getSlideParts } from './index';
+import { getParts, getSlideParts } from './index.js';
 
 // Test data
 const lyricsSample = `

package/tsconfig.json

@@ -26,9 +26,9 @@
     // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
 
     /* Modules */
-    "module": "commonjs",                                /* Specify what module code is generated. */
+    "module": "NodeNext",                                /* Specify what module code is generated. */
+    "moduleResolution": "NodeNext",                      /* Specify how TypeScript looks up a file from a given module specifier. */
     // "rootDir": "./",                                  /* Specify the root folder within your source files. */
-    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
     // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
     // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
     // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */