@magicborn/dialogue-forge 0.1.0

package/dist/esm/examples/example-loader.js

@@ -0,0 +1,103 @@
+import { importFromYarn } from '../lib/yarn-converter';
+import { examplesRegistry, getExampleMetadata, getExampleFlagSchema } from './examples-registry';
+/**
+ * Load an example dialogue from a Yarn file
+ * This is the unified way to load examples - all examples are Yarn files
+ */
+export async function loadExampleDialogue(exampleId) {
+    const metadata = getExampleMetadata(exampleId);
+    if (!metadata) {
+        console.warn(`Example not found: ${exampleId}`);
+        return null;
+    }
+    try {
+        // Dynamically import the Yarn file
+        // In a build environment, these will be bundled
+        // In Node.js/test environment, we'll read from filesystem
+        const yarnContent = await loadYarnFile(metadata.filename);
+        if (!yarnContent) {
+            console.warn(`Failed to load Yarn file: ${metadata.filename}`);
+            return null;
+        }
+        // Convert Yarn to DialogueTree
+        const dialogue = importFromYarn(yarnContent, metadata.title);
+        // Update node count in metadata if not set
+        if (!metadata.nodeCount) {
+            metadata.nodeCount = Object.keys(dialogue.nodes).length;
+        }
+        return dialogue;
+    }
+    catch (error) {
+        console.error(`Error loading example ${exampleId}:`, error);
+        return null;
+    }
+}
+/**
+ * Load Yarn file content
+ * This handles both browser (bundled) and Node.js (filesystem) environments
+ */
+async function loadYarnFile(filename) {
+    // In browser/build environment, we'll need to import as text
+    // For now, we'll use a simple approach that works in both
+    try {
+        // Try to import as a module (works in bundlers like Vite/Webpack)
+        if (typeof window !== 'undefined') {
+            // Browser environment - files should be imported as text
+            // This will be handled by the bundler configuration
+            const response = await fetch(`/examples/${filename}`);
+            if (response.ok) {
+                return await response.text();
+            }
+        }
+        // Node.js/test environment - read from filesystem
+        if (typeof require !== 'undefined') {
+            const fs = require('fs');
+            const path = require('path');
+            const filePath = path.join(__dirname, filename);
+            if (fs.existsSync(filePath)) {
+                return fs.readFileSync(filePath, 'utf8');
+            }
+        }
+        return null;
+    }
+    catch (error) {
+        console.error(`Error loading Yarn file ${filename}:`, error);
+        return null;
+    }
+}
+/**
+ * Get flag schema for an example
+ */
+export function getFlagSchemaForExample(exampleId) {
+    const metadata = getExampleMetadata(exampleId);
+    if (!metadata) {
+        return null;
+    }
+    return getExampleFlagSchema(metadata.flagSchemaId);
+}
+/**
+ * Get all examples with their metadata
+ */
+export function getAllExamples() {
+    return examplesRegistry.map(metadata => ({
+        ...metadata,
+        flagSchema: getExampleFlagSchema(metadata.flagSchemaId)
+    }));
+}
+/**
+ * Synchronous version for use with pre-loaded examples
+ * This is used when examples are bundled/inlined
+ */
+export function loadExampleDialogueSync(exampleId, yarnContent) {
+    const metadata = getExampleMetadata(exampleId);
+    if (!metadata) {
+        return null;
+    }
+    try {
+        return importFromYarn(yarnContent, metadata.title);
+    }
+    catch (error) {
+        console.error(`Error loading example ${exampleId}:`, error);
+        return null;
+    }
+}

package/dist/esm/examples/examples-registry.d.ts

@@ -0,0 +1,38 @@
+import { FlagSchema } from '../types/flags';
+/**
+ * Example metadata - describes each example file
+ */
+export interface ExampleMetadata {
+    id: string;
+    title: string;
+    description: string;
+    filename: string;
+    flagSchemaId: string;
+    nodeCount?: number;
+    features: string[];
+}
+/**
+ * Registry of all available examples
+ * This is the single source of truth for example discovery
+ */
+export declare const examplesRegistry: ExampleMetadata[];
+/**
+ * Flag schemas for examples
+ */
+export declare const exampleFlagSchemas: Record<string, FlagSchema>;
+/**
+ * Get example metadata by ID
+ */
+export declare function getExampleMetadata(id: string): ExampleMetadata | null;
+/**
+ * List all available example IDs
+ */
+export declare function listExampleIds(): string[];
+/**
+ * Get flag schema by ID
+ */
+export declare function getExampleFlagSchema(id: string): FlagSchema | null;
+/**
+ * List all available flag schema IDs
+ */
+export declare function listFlagSchemaIds(): string[];

package/dist/esm/examples/examples-registry.js

@@ -0,0 +1,153 @@
+import { FLAG_TYPE, FLAG_VALUE_TYPE } from '../types/constants';
+/**
+ * Registry of all available examples
+ * This is the single source of truth for example discovery
+ */
+export const examplesRegistry = [
+    {
+        id: 'basic',
+        title: 'Basic Dialogue Example',
+        description: 'Simple dialogue with player choices',
+        filename: 'basic-dialogue.yarn',
+        flagSchemaId: 'basic',
+        features: ['basic-choices']
+    },
+    {
+        id: 'conditional',
+        title: 'Conditional Dialogue Example',
+        description: 'Dialogue with conditional choices based on flags',
+        filename: 'conditional-dialogue.yarn',
+        flagSchemaId: 'conditional',
+        features: ['conditional-choices', 'flag-checks']
+    },
+    {
+        id: 'quest-progression',
+        title: 'Quest Progression Example',
+        description: 'Quest system with progression and rewards',
+        filename: 'quest-progression.yarn',
+        flagSchemaId: 'rpg',
+        features: ['quest-progression', 'flag-setting']
+    },
+    {
+        id: 'complex-conditional',
+        title: 'Complex Conditional Example',
+        description: 'Advanced conditional logic with multiple branches',
+        filename: 'complex-conditional.yarn',
+        flagSchemaId: 'complex_conditional',
+        features: ['conditional-nodes', 'multiple-branches', 'complex-conditions']
+    },
+    {
+        id: 'variable-operations',
+        title: 'Variable Operations Example',
+        description: 'Demonstrates variable operations, interpolation, and numeric calculations',
+        filename: 'variable-operations-example.yarn',
+        flagSchemaId: 'rpg',
+        features: ['variable-operations', 'variable-interpolation', 'numeric-calculations', 'string-variables']
+    }
+];
+/**
+ * Flag schemas for examples
+ */
+export const exampleFlagSchemas = {
+    basic: {
+        categories: ['quests', 'items', 'stats'],
+        flags: [
+            { id: 'quest_intro', name: 'Introduction Quest', type: FLAG_TYPE.QUEST, category: 'quests', valueType: FLAG_VALUE_TYPE.STRING },
+            { id: 'item_key', name: 'Key', type: FLAG_TYPE.ITEM, category: 'items' },
+            { id: 'stat_reputation', name: 'Reputation', type: FLAG_TYPE.STAT, category: 'stats', valueType: FLAG_VALUE_TYPE.NUMBER, defaultValue: 0 },
+        ]
+    },
+    conditional: {
+        categories: ['quests', 'items', 'stats'],
+        flags: [
+            { id: 'quest_main', name: 'Main Quest', type: FLAG_TYPE.QUEST, category: 'quests', valueType: FLAG_VALUE_TYPE.STRING },
+            { id: 'item_key', name: 'Key', type: FLAG_TYPE.ITEM, category: 'items' },
+            { id: 'stat_gold', name: 'Gold', type: FLAG_TYPE.STAT, category: 'stats', valueType: FLAG_VALUE_TYPE.NUMBER, defaultValue: 0 },
+            { id: 'stat_reputation', name: 'Reputation', type: FLAG_TYPE.STAT, category: 'stats', valueType: FLAG_VALUE_TYPE.NUMBER, defaultValue: 0 },
+        ]
+    },
+    rpg: {
+        categories: ['quests', 'achievements', 'items', 'stats', 'titles'],
+        flags: [
+            { id: 'quest_dragon_slayer', name: 'Dragon Slayer Quest', type: FLAG_TYPE.QUEST, category: 'quests', valueType: FLAG_VALUE_TYPE.STRING },
+            { id: 'quest_dragon_slayer_complete', name: 'Dragon Slayer Complete', type: FLAG_TYPE.QUEST, category: 'quests' },
+            { id: 'quest_find_key', name: 'Find the Key', type: FLAG_TYPE.QUEST, category: 'quests', valueType: FLAG_VALUE_TYPE.STRING },
+            { id: 'achievement_first_quest', name: 'First Quest', type: FLAG_TYPE.ACHIEVEMENT, category: 'achievements' },
+            { id: 'achievement_dragon_slayer', name: 'Dragon Slayer', type: FLAG_TYPE.ACHIEVEMENT, category: 'achievements' },
+            { id: 'achievement_hero', name: 'Hero', type: FLAG_TYPE.ACHIEVEMENT, category: 'achievements' },
+            { id: 'item_ancient_key', name: 'Ancient Key', type: FLAG_TYPE.ITEM, category: 'items' },
+            { id: 'item_map', name: 'Treasure Map', type: FLAG_TYPE.ITEM, category: 'items' },
+            { id: 'item_sword', name: 'Legendary Sword', type: FLAG_TYPE.ITEM, category: 'items' },
+            { id: 'item_potion', name: 'Health Potion', type: FLAG_TYPE.ITEM, category: 'items' },
+            { id: 'stat_gold', name: 'Gold', type: FLAG_TYPE.STAT, category: 'stats', valueType: FLAG_VALUE_TYPE.NUMBER, defaultValue: 0 },
+            { id: 'stat_reputation', name: 'Reputation', type: FLAG_TYPE.STAT, category: 'stats', valueType: FLAG_VALUE_TYPE.NUMBER, defaultValue: 0 },
+            { id: 'stat_charisma', name: 'Charisma', type: FLAG_TYPE.STAT, category: 'stats', valueType: FLAG_VALUE_TYPE.NUMBER, defaultValue: 10 },
+            { id: 'stat_strength', name: 'Strength', type: FLAG_TYPE.STAT, category: 'stats', valueType: FLAG_VALUE_TYPE.NUMBER, defaultValue: 10 },
+            { id: 'stat_experience', name: 'Experience', type: FLAG_TYPE.STAT, category: 'stats', valueType: FLAG_VALUE_TYPE.NUMBER, defaultValue: 0 },
+            { id: 'title_hero', name: 'Hero', type: FLAG_TYPE.TITLE, category: 'titles' },
+            { id: 'title_merchant', name: 'Merchant', type: FLAG_TYPE.TITLE, category: 'titles' },
+            { id: 'player_name', name: 'Player Name', type: FLAG_TYPE.GLOBAL, category: 'global', valueType: FLAG_VALUE_TYPE.STRING, defaultValue: 'Traveler' },
+            { id: 'location_name', name: 'Location Name', type: FLAG_TYPE.GLOBAL, category: 'global', valueType: FLAG_VALUE_TYPE.STRING, defaultValue: 'Town' },
+            { id: 'player_title', name: 'Player Title', type: FLAG_TYPE.TITLE, category: 'titles', valueType: FLAG_VALUE_TYPE.STRING },
+            { id: 'greeting_count', name: 'Greeting Count', type: FLAG_TYPE.STAT, category: 'stats', valueType: FLAG_VALUE_TYPE.NUMBER, defaultValue: 0 },
+        ]
+    },
+    complex_conditional: {
+        categories: ['quests', 'achievements', 'items', 'stats', 'titles', 'global', 'dialogue'],
+        flags: [
+            { id: 'quest_ancient_ruins', name: 'Ancient Ruins Quest', type: FLAG_TYPE.QUEST, category: 'quests', valueType: FLAG_VALUE_TYPE.STRING },
+            { id: 'quest_ancient_ruins_complete', name: 'Ancient Ruins Complete', type: FLAG_TYPE.QUEST, category: 'quests' },
+            { id: 'quest_treasure_hunt', name: 'Treasure Hunt', type: FLAG_TYPE.QUEST, category: 'quests', valueType: FLAG_VALUE_TYPE.STRING },
+            { id: 'quest_treasure_hunt_complete', name: 'Treasure Hunt Complete', type: FLAG_TYPE.QUEST, category: 'quests' },
+            { id: 'quest_dragon_slayer', name: 'Dragon Slayer Quest', type: FLAG_TYPE.QUEST, category: 'quests', valueType: FLAG_VALUE_TYPE.STRING },
+            { id: 'achievement_explorer', name: 'Explorer', type: FLAG_TYPE.ACHIEVEMENT, category: 'achievements' },
+            { id: 'achievement_rich', name: 'Rich', type: FLAG_TYPE.ACHIEVEMENT, category: 'achievements' },
+            { id: 'achievement_hero', name: 'Hero', type: FLAG_TYPE.ACHIEVEMENT, category: 'achievements' },
+            { id: 'achievement_diplomat', name: 'Diplomat', type: FLAG_TYPE.ACHIEVEMENT, category: 'achievements' },
+            { id: 'item_ancient_key', name: 'Ancient Key', type: FLAG_TYPE.ITEM, category: 'items' },
+            { id: 'item_treasure_map', name: 'Treasure Map', type: FLAG_TYPE.ITEM, category: 'items' },
+            { id: 'item_legendary_sword', name: 'Legendary Sword', type: FLAG_TYPE.ITEM, category: 'items' },
+            { id: 'item_gold_coin', name: 'Gold Coin', type: FLAG_TYPE.ITEM, category: 'items' },
+            { id: 'stat_gold', name: 'Gold', type: FLAG_TYPE.STAT, category: 'stats', valueType: FLAG_VALUE_TYPE.NUMBER, defaultValue: 0 },
+            { id: 'stat_reputation', name: 'Reputation', type: FLAG_TYPE.STAT, category: 'stats', valueType: FLAG_VALUE_TYPE.NUMBER, defaultValue: 0 },
+            { id: 'stat_charisma', name: 'Charisma', type: FLAG_TYPE.STAT, category: 'stats', valueType: FLAG_VALUE_TYPE.NUMBER, defaultValue: 10 },
+            { id: 'stat_strength', name: 'Strength', type: FLAG_TYPE.STAT, category: 'stats', valueType: FLAG_VALUE_TYPE.NUMBER, defaultValue: 10 },
+            { id: 'stat_wisdom', name: 'Wisdom', type: FLAG_TYPE.STAT, category: 'stats', valueType: FLAG_VALUE_TYPE.NUMBER, defaultValue: 10 },
+            { id: 'title_hero', name: 'Hero', type: FLAG_TYPE.TITLE, category: 'titles' },
+            { id: 'title_explorer', name: 'Explorer', type: FLAG_TYPE.TITLE, category: 'titles' },
+            { id: 'title_merchant', name: 'Merchant', type: FLAG_TYPE.TITLE, category: 'titles' },
+            { id: 'global_game_started', name: 'Game Started', type: FLAG_TYPE.GLOBAL, category: 'global' },
+            { id: 'global_first_visit', name: 'First Visit', type: FLAG_TYPE.GLOBAL, category: 'global' },
+            { id: 'global_difficulty', name: 'Difficulty', type: FLAG_TYPE.GLOBAL, category: 'global', valueType: FLAG_VALUE_TYPE.STRING },
+            { id: 'dialogue_met_guard', name: 'Met Guard', type: FLAG_TYPE.DIALOGUE, category: 'dialogue' },
+            { id: 'dialogue_hostile', name: 'Hostile Response', type: FLAG_TYPE.DIALOGUE, category: 'dialogue' },
+            { id: 'dialogue_friendly', name: 'Friendly Response', type: FLAG_TYPE.DIALOGUE, category: 'dialogue' },
+            { id: 'dialogue_seeks_knowledge', name: 'Seeks Knowledge', type: FLAG_TYPE.DIALOGUE, category: 'dialogue' },
+            { id: 'dialogue_offered_bribe', name: 'Offered Bribe', type: FLAG_TYPE.DIALOGUE, category: 'dialogue' },
+        ]
+    }
+};
+/**
+ * Get example metadata by ID
+ */
+export function getExampleMetadata(id) {
+    return examplesRegistry.find(ex => ex.id === id) || null;
+}
+/**
+ * List all available example IDs
+ */
+export function listExampleIds() {
+    return examplesRegistry.map(ex => ex.id);
+}
+/**
+ * Get flag schema by ID
+ */
+export function getExampleFlagSchema(id) {
+    return exampleFlagSchemas[id] || null;
+}
+/**
+ * List all available flag schema IDs
+ */
+export function listFlagSchemaIds() {
+    return Object.keys(exampleFlagSchemas);
+}

package/dist/esm/examples/index.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Unified Examples System
+ *
+ * All examples are stored as Yarn files and loaded through the registry system.
+ * This provides a single, organized way to discover and load examples.
+ *
+ * Structure:
+ * - examples-registry.ts: Metadata about all examples (titles, descriptions, features)
+ * - yarn-examples.ts: Actual Yarn file contents (all examples as Yarn strings)
+ * - legacy-examples.ts: Old TypeScript examples (being migrated to Yarn format)
+ * - index.ts: Public API for loading examples (this file)
+ */
+export { examplesRegistry, exampleFlagSchemas, getExampleMetadata, listExampleIds, getExampleFlagSchema, listFlagSchemaIds, type ExampleMetadata } from './examples-registry';
+/**
+ * Legacy exports for backward compatibility
+ * These maintain the old API while we migrate examples to Yarn format
+ * TODO: Remove once all examples are migrated and code is updated
+ */
+import { DialogueTree } from '../types';
+import { FlagSchema } from '../types/flags';
+export declare const exampleDialogues: Record<string, DialogueTree>;
+export declare const demoFlagSchemas: Record<string, FlagSchema>;
+export declare function listExamples(): string[];
+export declare function listDemoFlagSchemas(): string[];
+export declare function getExampleDialogue(name: string): DialogueTree | null;
+export declare function getDemoFlagSchema(name: string): FlagSchema | null;

package/dist/esm/examples/index.js

@@ -0,0 +1,50 @@
+/**
+ * Unified Examples System
+ *
+ * All examples are stored as Yarn files and loaded through the registry system.
+ * This provides a single, organized way to discover and load examples.
+ *
+ * Structure:
+ * - examples-registry.ts: Metadata about all examples (titles, descriptions, features)
+ * - yarn-examples.ts: Actual Yarn file contents (all examples as Yarn strings)
+ * - legacy-examples.ts: Old TypeScript examples (being migrated to Yarn format)
+ * - index.ts: Public API for loading examples (this file)
+ */
+// New unified system exports
+export { examplesRegistry, exampleFlagSchemas, getExampleMetadata, listExampleIds, getExampleFlagSchema, listFlagSchemaIds } from './examples-registry';
+import { getExampleDialogue as getYarnExampleDialogue } from './yarn-examples';
+import { listExampleIds, listFlagSchemaIds, getExampleFlagSchema } from './examples-registry';
+import { exampleDialogues as legacyExamples, demoFlagSchemas as legacySchemas } from './legacy-examples';
+// Export legacy examples - these work alongside the new Yarn examples
+export const exampleDialogues = legacyExamples;
+export const demoFlagSchemas = legacySchemas;
+export function listExamples() {
+    // Combine both Yarn examples and legacy examples
+    const yarnIds = listExampleIds();
+    const legacyIds = Object.keys(legacyExamples);
+    return [...new Set([...yarnIds, ...legacyIds])];
+}
+export function listDemoFlagSchemas() {
+    // Combine both systems
+    const yarnIds = listFlagSchemaIds();
+    const legacyIds = Object.keys(legacySchemas);
+    return [...new Set([...yarnIds, ...legacyIds])];
+}
+export function getExampleDialogue(name) {
+    // Try new Yarn system first
+    const yarnDialogue = getYarnExampleDialogue(name);
+    if (yarnDialogue) {
+        return yarnDialogue;
+    }
+    // Fallback to legacy TypeScript examples
+    return legacyExamples[name] || null;
+}
+export function getDemoFlagSchema(name) {
+    // Try new system first
+    const schema = getExampleFlagSchema(name);
+    if (schema) {
+        return schema;
+    }
+    // Fallback to legacy
+    return legacySchemas[name] || null;
+}

package/dist/esm/examples/legacy-examples.d.ts

@@ -0,0 +1,9 @@
+import { DialogueTree } from '../types';
+import { FlagSchema } from '../types/flags';
+/**
+ * Legacy TypeScript examples
+ * These are kept for backward compatibility while we migrate to Yarn format
+ * TODO: Convert these to Yarn format and remove this file
+ */
+export declare const demoFlagSchemas: Record<string, FlagSchema>;
+export declare const exampleDialogues: Record<string, DialogueTree>;