वेब ऐप्लिकेशन स्कोप एक्सटेंशन

Chrome 122 से, scope_extensions ऐप्लिकेशन मेनिफ़ेस्ट मेंबर के लिए ऑरिजिन ट्रायल की सदस्यता ली जा सकती है. इससे, कई सबडोमेन और टॉप लेवल डोमेन को कंट्रोल करने वाली साइटों को एक वेब ऐप्लिकेशन के तौर पर दिखाया जा सकता है. इस दस्तावेज़ में बताया गया है कि Chrome की टीम इस सुविधा को क्यों लॉन्च कर रही है और आपको इसका इस्तेमाल कब करना चाहिए.

खास जानकारी

कुछ वेब ऐप्लिकेशन में कई ऑरिजिन होते हैं. उदाहरण के लिए, मुख्य ऐप्लिकेशन के तौर पर example.com और फिर सब-एक्सपीरियंस के तौर पर space_1.example.com, …, space_n.example.com. कभी-कभी, special-example.com को भी सब-एक्सपीरियंस के तौर पर शामिल किया जाता है. ये सभी मुख्य ऐप्लिकेशन के तहत आते हैं. इस तरह के साइट आर्किटेक्चर का असर, प्रोग्रेसिव वेब ऐप्लिकेशन पर पड़ता है. इन सीमाओं में, सर्विस वर्कर, किसी भी तरह के डिवाइस, लोकल स्टोरेज, और अलग-अलग ऑरिजिन के बीच अनुमतियां शेयर न कर पाना शामिल है. साथ ही, स्टैंडअलोन पीडब्ल्यूए में क्रॉस-ऑरिजिन नेविगेशन, विंडो यूज़र इंटरफ़ेस (यूआई) ("स्कोप से बाहर" बार) दिखाता है. इससे पता चलता है कि उपयोगकर्ता, पीडब्ल्यूए के अनुभव से बाहर चला गया है. इनमें से कुछ समस्याओं को हल करने का तरीका जानने के लिए, ये लेख पढ़ें: एक से ज़्यादा ऑरिजिन वाली साइटों में प्रोग्रेसिव वेब ऐप्लिकेशन और एक ही डोमेन पर कई प्रोग्रेसिव वेब ऐप्लिकेशन बनाना.

Scope Extensions API की मदद से, वेब ऐप्लिकेशन उन कुछ चुनौतियों से पार पा सकते हैं जो सेम-ऑरिजिन नीति इस तरह के साइट आर्किटेक्चर पर लागू करती है. इसकी मदद से, वेब ऐप्लिकेशन अपने स्कोप को अन्य ऑरिजिन तक बढ़ा सकते हैं, ताकि उपयोगकर्ताओं को एक जैसा अनुभव मिल सके. हालांकि, इसके लिए वेब ऐप्लिकेशन के मुख्य ऑरिजिन और उससे जुड़े ऑरिजिन के बीच सहमति होनी चाहिए.

लक्ष्य

Scope Extensions API का मुख्य मकसद, कई सबडोमेन और टॉप लेवल डोमेन को कंट्रोल करने वाली साइटों को एक ही वेब ऐप्लिकेशन के तौर पर काम करने की अनुमति देना है. ऐसा तब होता है, जब वेब ऐप्लिकेशन के यूज़र इंटरफ़ेस (यूआई) और लिंक कैप्चर करने की बात आती है. उदाहरण के लिए, example.com को example.com.co.uk और support.example.com तक फैलाकर, उसे ज़्यादा से ज़्यादा एक वेब ऐप्लिकेशन की तरह काम करने की अनुमति देना.

मुख्य पीडब्ल्यूए और उससे जुड़े सब-एक्सपीरियंस दिखाने वाला डायग्राम.

स्कोप एक्सटेंशन की मदद से, कई ऑरिजिन वाले पीडब्ल्यूए, वेब ऐप्लिकेशन के यूज़र इंटरफ़ेस (यूआई) के मामले में एक ही वेब ऐप्लिकेशन की तरह काम कर सकते हैं.

व्यावहारिक तौर पर, इसका मतलब दो और खास लक्ष्यों से है:

  • क्रॉस-ऑरिजिन नेविगेशन: उपयोगकर्ताओं को असोसिएट किए गए ऑरिजिन पर नेविगेट करने की अनुमति दें. इसके लिए, विंडो यूज़र इंटरफ़ेस (यूआई) को ट्रिगर करके उपयोगकर्ता को यह जानकारी दें कि वे पीडब्ल्यूए से दूर जा रहे हैं. इससे उपयोगकर्ता अनुभव में कोई रुकावट नहीं आएगी.
  • क्रॉस-ऑरिजिन लिंक कैप्चर करना: वेब ऐप्लिकेशन को, उपयोगकर्ता के नेविगेशन को उन साइटों पर कैप्चर करने की अनुमति दें जिनसे वे जुड़े हुए हैं.

क्रॉस-ऑरिजिन इन-स्कोप नेविगेशन

डिफ़ॉल्ट रूप से, जब उपयोगकर्ता किसी स्टैंडअलोन पीडब्ल्यूए में एक ऑरिजिन से दूसरे ऑरिजिन पर जाते हैं, तो उन्हें एक विंडो यूज़र इंटरफ़ेस (यूआई) दिखाया जाता है. इससे पता चलता है कि वे पीडब्ल्यूए के अनुभव से बाहर जा रहे हैं. Chrome में, इस यूज़र इंटरफ़ेस (यूआई) में "आउट ऑफ़ स्कोप" बार होता है. इसमें नए ऑरिजिन का यूआरएल होता है. इससे उपयोगकर्ता अनुभव खराब होता है, क्योंकि उपयोगकर्ताओं को उम्मीद होती है कि वे उसी ऐप्लिकेशन के कॉन्टेंट को ब्राउज़ करना जारी रखेंगे. हालांकि, उन्हें लग सकता है कि उन्हें ऐप्लिकेशन से बाहर ले जाया जा रहा है.

स्टैंडअलोन पीडब्ल्यूए के सबसे ऊपर मौजूद आउट ऑफ़ स्कोप बार.

जब उपयोगकर्ता किसी स्टैंडअलोन पीडब्ल्यूए में अलग-अलग ऑरिजिन पर नेविगेट करते हैं, तो Chrome में "स्कोप से बाहर" बार दिखता है.

स्कोप एक्सटेंशन की मदद से, जब उपयोगकर्ता किसी भी असोसिएटेड ऑरिजिन पर नेविगेट करेंगे, तो विंडो यूज़र इंटरफ़ेस (यूआई) नहीं दिखेगा. इससे पीडब्ल्यूए को एक जैसा अनुभव मिलता है.

लिंक कैप्चर करने का मतलब है कि कोई ऐप्लिकेशन अपने दायरे में मौजूद लिंक को कैप्चर कर सकता है. इसे लागू करने का तरीका, ब्राउज़र और ऑपरेटिंग सिस्टम के हिसाब से अलग-अलग होता है. उदाहरण के लिए, ChromeOS पर Chrome में, इंस्टॉल किए गए पीडब्ल्यूए के दायरे में आने वाले लिंक, डिफ़ॉल्ट रूप से ब्राउज़र टैब में खुलते हैं. साथ ही, पता बार में यह जानकारी दिखती है कि इन लिंक को हैंडल करने वाला ऐप्लिकेशन मौजूद है. इससे उपयोगकर्ता, उस समय से लिंक अपने-आप कैप्चर होने की सुविधा के लिए ऑप्ट-इन कर सकता है.

इंस्टॉल किए गए पीडब्ल्यूए के लिए, Omnibar प्रॉम्प्ट.

ChromeOS में किसी टैब के लिए, Chrome के पता बार का फ़्रैगमेंट. इसमें विज़ुअल इंडिकेशन दिख रहा है कि लिंक को PWA से मैनेज किया जा सकता है. साथ ही, इस फ़ैसले को याद रखने का विकल्प भी दिख रहा है.

अगर कोई उपयोगकर्ता किसी ऐसे लिंक पर क्लिक करता है जो पीडब्ल्यूए के दायरे से बाहर है, तो उसे पीडब्ल्यूए का हिस्सा नहीं माना जाएगा. इसमें सबडोमेन या टॉप-लेवल डोमेन के लिंक शामिल हैं. उदाहरण के लिए, लिंक किसी ब्राउज़र टैब में खुलेंगे. इस दौरान, उपयोगकर्ता को यह नहीं बताया जाएगा कि कोई ऐसा ऐप्लिकेशन है जो लिंक को हैंडल कर सकता है. Scope Extensions API की मदद से, पीडब्ल्यूए के स्कोप को बढ़ाया जा सकता है, ताकि उससे जुड़े ऑरिजिन को इन-स्कोप लिंक के तौर पर माना जा सके.

लागू करना

स्कोप एक्सटेंशन लागू करने के लिए, मुख्य ऑरिजिन और उससे जुड़े ऑरिजिन के बीच संबंध बनाना ज़रूरी है.

जुड़े हुए ऑरिजिन की सूची का एलान करना

मुख्य पीडब्ल्यूए ऑरिजिन में scope_extensions वेब ऐप्लिकेशन मेनिफ़ेस्ट मेंबर जोड़ें, ताकि वेब ऐप्लिकेशन को अन्य ऑरिजिन तक बढ़ाया जा सके.

वेब ऐप्लिकेशन मेनिफ़ेस्ट (https://example.com)

{
  "id": "/",
  "name": "Example",
  "display": "standalone",
  "start_url": "/index.html",
  "scope_extensions": [
    { "type": "origin", "origin": "https://help.example.com" },
    { "type": "origin", "origin": "https://example.co.uk" },
    { "type": "origin", "origin": "https://help.example.co.uk" }
  ]
}

असोसिएशन की पुष्टि करना

सूची में शामिल हर ऑरिजिन, /.well-known/web-app-origin-association कॉन्फ़िगरेशन फ़ाइल का इस्तेमाल करके, वेब ऐप्लिकेशन के साथ असोसिएशन की पुष्टि करता है. इस फ़ाइल का नाम web-app-origin-association होना चाहिए और इसे इसी जगह पर उपलब्ध कराया जाना चाहिए, क्योंकि यह एक जाने-माने यूआरआई है.

/.well-known/web-app-origin-association (associated origin)

{
  "https://example.com/": {
    "scope": "/"
  }
}

इस फ़ाइल में उन वेब ऐप्लिकेशन की सूची होती है जिनसे ऑरिजिन जुड़ा होता है. हर कुंजी, वेब ऐप्लिकेशन का मेनिफ़ेस्ट आईडी होती है. साथ ही, हर वैल्यू के लिए एक वैकल्पिक दायरा सेट किया जा सकता है, जो उससे जुड़े ऑरिजिन के हिसाब से होता है. अगर स्कोप को शामिल नहीं किया जाता है, तो यह डिफ़ॉल्ट रूप से "/" पर सेट हो जाता है.

डेमो

डेमो में दो साइटें शामिल हैं:

ये टेस्ट करने के लिए, आपको about://flags/#enable-desktop-pwas-scope-extensions फ़्लैग चालू करना होगा. यह फ़्लैग, Chrome के वर्शन 115 और इसके बाद के वर्शन में उपलब्ध है.

क्रॉस-ऑरिजिन नेविगेशन की जांच करना

इन टेस्ट को शुरू करने से पहले, किसी ब्राउज़र में मुख्य PWA खोलें. इसके बाद, इसे PWA के तौर पर इंस्टॉल करें और स्टैंडअलोन मोड में चलाने के लिए इसे खोलें. पीडब्ल्यूए में, एक्सटेंडेड स्कोप में मौजूद ऑरिजिन और एक्सटेंडेड स्कोप में मौजूद नहीं होने वाले ऑरिजिन के लिंक शामिल हैं.

स्कोप में मौजूद और एक्सटेंडेड स्कोप वाले लिंक के साथ मुख्य पीडब्ल्यूए विंडो.

डेमो पीडब्ल्यूए, जिसमें एक्सटेंडेड स्कोप में मौजूद ऑरिजिन और एक्सटेंडेड स्कोप में मौजूद नहीं होने वाले ऑरिजिन के लिंक शामिल हैं.

डिफ़ॉल्ट क्रॉस-ऑरिजिन नेविगेशन (एक्सटेंडेड स्कोप में नहीं)

  1. फ़ुल स्क्रीन पीडब्ल्यूए में, ओरिजिन, एक्सटेंडेड स्कोप में नहीं है लिंक पर क्लिक करें.
  2. इस वजह से, नेविगेशन होता है और स्कोप से बाहर का बार दिखता है.

'दायरे से बाहर' लिंक पर क्लिक करने के बाद, दायरे से बाहर वाले बार के साथ मुख्य PWA विंडो.

स्टैंडअलोन मोड में किसी PWA के लिए, क्रॉस-ऑरिजिन नेविगेशन के लिए डिफ़ॉल्ट रूप से "स्कोप से बाहर" बार दिखाया जाता है.

स्कोप एक्सटेंशन (एक्सटेंडेड स्कोप में) के साथ क्रॉस-ऑरिजिन नेविगेशन

  1. पीडब्ल्यूए के होम पेज पर वापस जाएं.
  2. एक्सटेंडेड स्कोप में शामिल नहीं किए गए ऑरिजिन के लिंक पर क्लिक करें.
  3. डिफ़ॉल्ट रूप से, "स्कोप से बाहर" बार दिखना चाहिए. हालांकि, स्कोप एक्सटेंशन असोसिएशन की वजह से, ऐसा नहीं होता.

एक्सटेंडेड स्कोप लिंक पर क्लिक करने के बाद, आउट ऑफ़ स्कोप बार के बिना मुख्य पीडब्ल्यूए विंडो.

स्कोप एक्सटेंशन के साथ ऑरिजिन असोसिएशन बनाने के बाद, क्रॉस-ऑरिजिन नेविगेशन में "स्कोप से बाहर" बार नहीं दिखता.

  1. किसी ChromeOS डिवाइस में मुख्य पीडब्ल्यूए को खोलें और इंस्टॉल करें.
  2. इस लिंक पर क्लिक करें: associated origin.
  3. लिंक, ब्राउज़र के नए टैब में खुलता है और इंस्टॉल किए गए पीडब्ल्यूए में इसे खोलने के लिए एक प्रॉम्प्ट दिखता है.

इंस्टॉल किए गए ऐसे पीडब्ल्यूए के लिए पता बार में दिखने वाला प्रॉम्प्ट जिसका दायरा बढ़ाया गया है.

पीडब्ल्यूए से जुड़े ऑरिजिन के लिंक पर क्लिक करने से, लिंक नए टैब में खुलता है. साथ ही, "ऐप्लिकेशन में खोलें" आइकॉन दिखता है. इससे उपयोगकर्ता, लिंक को अपने-आप कैप्चर करने की सुविधा के लिए ऑप्ट-इन कर सकता है.

ऑरिजिन ट्रायल

अगर आपको अपने ऐप्लिकेशन में इस एपीआई को असल उपयोगकर्ताओं के साथ टेस्ट करना है, तो ऑरिजिन ट्रायल की मदद से ऐसा किया जा सकता है. ऑरिजिन ट्रायल की मदद से, उपयोगकर्ताओं के साथ एक्सपेरिमेंट के तौर पर उपलब्ध सुविधाओं को आज़माया जा सकता है. इसके लिए, आपको टेस्टिंग टोकन लेना होगा. यह टोकन आपके डोमेन से जुड़ा होता है. इसके बाद, अपने ऐप्लिकेशन को डिप्लॉय किया जा सकता है. साथ ही, यह उम्मीद की जा सकती है कि यह ऐप्लिकेशन उस ब्राउज़र में काम करेगा जो आपकी जांच की जा रही सुविधा के साथ काम करता है. इस मामले में, यह सुविधा Chrome 121 से 126 तक उपलब्ध है. ऑरिजिन ट्रायल चलाने के लिए, अपना टोकन पाने के लिए आवेदन फ़ॉर्म भरें.

सुझाव/राय दें या शिकायत करें

Chrome की टीम, इस एपीआई की उपयोगिता के बारे में सुझाव, शिकायत या राय पाना चाहती है. इस एपीआई को बेहतर बनाने में टीम की मदद करें. इसके लिए, एपीआई के फ़ायदों के बारे में सुझाव/राय दें या शिकायत करें. साथ ही, इस्तेमाल के ऐसे नए उदाहरणों के बारे में बताएं जो मौजूदा वर्शन में शामिल नहीं हैं. इसके लिए, GitHub पर समस्या दर्ज करें.

अन्य संसाधन

Acknowledgements

इस एपीआई को डेवलप करने वाली टीम को खास धन्यवाद. Scope Extensions को एलन कटर और लू हुआंग ने तय किया था. इसमें मैट ज्यूका ने भी योगदान दिया था. इस एपीआई को Google Chrome के एलन कटर और Microsoft Edge के हसन तलत, क्रिस्टिन ली, और लू हुआंग ने लागू किया था.