JSON से TypeScript इंटरफ़ेस जनरेटर

TypeScript बड़े पैमाने पर JavaScript डेवलपमेंट के लिए मुख्य भाषा बन गई है, और इसकी सबसे बड़ी खासियत 'compile-time type safety' है। REST API का इस्तेमाल करते समय, JSON कॉन्फ़िगरेशन फ़ाइलों को प्रोसेस करते समय, या बाहरी स्रोतों से डेटा को हैंडल करते समय, TypeScript डेवलपर्स को सटीक 'type definitions' की ज़रूरत होती है जो आने वाले डेटा के स्ट्रक्चर (shape) को बता सकें। सही 'types' के बिना, API रिस्पॉन्स ऑब्जेक्ट्स को 'any' के तौर पर माना जाता है, जिससे TypeScript का मकसद ही खत्म हो जाता है — IDE ऑटो-कम्प्लीशन काम नहीं करता, कोड में बदलाव (refactoring) असुरक्षित हो जाते हैं, और 'type errors' जो 'compile-time' पर पकड़े जा सकते थे, वे 'runtime exceptions' के तौर पर सामने आते हैं। जब कोई औपचारिक OpenAPI या JSON Schema स्पेसिफिकेशन उपलब्ध न हो, तो असली JSON उदाहरणों से TypeScript इंटरफ़ेस बनाना सटीक 'type definitions' तैयार करने का सबसे तेज़ तरीका है।

JSON-से-TypeScript कन्वर्ज़न के लिए टाइप इन्फ़रेंस एल्गोरिदम, सीधे संबंध के ज़रिए हर JSON वैल्यू टाइप को उसके TypeScript इक्विवैलेंट (समकक्ष) से मैप करता है। JSON स्ट्रिंग्स, TypeScript स्ट्रिंग बन जाती हैं। JSON नंबर्स (इंटीजर और फ़्लोट दोनों, क्योंकि JSON इनमें फ़र्क नहीं करता) TypeScript नंबर बन जाते हैं। JSON बूलियन, TypeScript बूलियन बन जाते हैं। JSON null, TypeScript null बन जाता है। JSON ऑब्जेक्ट्स, TypeScript इंटरफ़ेस डिक्लेरेशन बन जाते हैं, जिसमें हर की (key) एक ज़रूरी प्रॉपर्टी होती है और उसका टाइप उसकी वैल्यू के इन्फ़र्ड टाइप (अनुमानित प्रकार) के आधार पर तय होता है। JSON एरे, TypeScript एरे टाइप (ElementType[]) बन जाते हैं, जहाँ एलिमेंट टाइप का पता पहले एरे एलिमेंट से लगाया जाता है। ये मैपिंग्स असल दुनिया के ज़्यादातर API डेटा स्ट्रक्चर्स को बिना किसी उलझन के हैंडल करती हैं।

नेस्टेड JSON ऑब्जेक्ट्स को हर अलग ऑब्जेक्ट शेप के लिए अलग-अलग नाम वाले इंटरफेस बनाकर हैंडल किया जाता है, जो इनलाइन एनॉनिमस टाइप्स की तुलना में ज़्यादा साफ़ और दोबारा इस्तेमाल करने लायक होते हैं। एक JSON रिस्पॉन्स जिसमें टॉप-लेवल पर एक यूज़र ऑब्जेक्ट हो और उसमें सिटी फ़ील्ड वाला एड्रेस ऑब्जेक्ट हो, उससे तीन इंटरफेस बनते हैं: Address (जिसमें city: string हो), User (जिसमें address: Address हो), और Root (जिसमें user: User हो)। यह हायरार्किकल डीकम्पोज़िशन TypeScript डॉक्यूमेंटेशन में बताए गए स्टाइल से मेल खाता है और ऐसे इंटरफेस बनाता है जिन्हें कोडबेस में अलग-अलग इंपोर्ट, एक्सटेंड या दोबारा इस्तेमाल किया जा सकता है। इंटरफेस के नाम PascalCase कन्वेंशन में JSON कीज़ के नामों से लिए जाते हैं।

JSON-सैंपल पर आधारित टाइप जनरेशन की एक व्यावहारिक सीमा यह है कि जनरेटर केवल उसी चीज़ का अनुमान लगा सकता है जो दिए गए उदाहरण में मौजूद है। अगर असल API रिस्पॉन्स में कोई फ़ील्ड कभी 'null' और कभी 'string' होता है, लेकिन दिए गए उदाहरण में सिर्फ़ 'string' वाला मामला दिखाया गया है, तो जनरेट किया गया टाइप 'string | null' के बजाय सिर्फ़ 'string' होगा। अगर कुछ फ़ील्ड ऑप्शनल हैं (कभी मौजूद होते हैं, तो कभी नहीं), तो भी जनरेटर उन्हें 'required' (ज़रूरी) के तौर पर मार्क करेगा क्योंकि वे सैंपल में दिख रहे हैं। डेवलपर्स को जनरेट किए गए इंटरफ़ेस को एक शुरुआती बिंदु मानना चाहिए और पूरे API कॉन्ट्रैक्ट डॉक्यूमेंटेशन के आधार पर उन्हें बेहतर बनाना चाहिए; साथ ही, पूरे डेटा मॉडल को सही ढंग से दिखाने के लिए ज़रूरत के अनुसार यूनियन टाइप, ऑप्शनल मार्कर (?) और जेनेरिक्स जोड़ने चाहिए।