feat(altlang): utility for fetching all alternative languages on page (#580)

Author: jeffchew

packages/react/.storybook/preview-head.html

@@ -1,2 +1,137 @@
+<link rel="alternate" hreflang="en-us" href="https://www.ibm.com/us-en/">
+<link rel="alternate" hreflang="x-default" href="https://www.ibm.com">
+<link rel="alternate" hreflang="en-af" href="https://www.ibm.com/af-en">
+<link rel="alternate" hreflang="fr-dz" href="https://www.ibm.com/dz-fr">
+<link rel="alternate" hreflang="pt-ao" href="https://www.ibm.com/ao-pt">
+<link rel="alternate" hreflang="en-ai" href="https://www.ibm.com/ai-en">
+<link rel="alternate" hreflang="en-ag" href="https://www.ibm.com/ag-en">
+<link rel="alternate" hreflang="es-ar" href="https://www.ibm.com/ar-es">
+<link rel="alternate" hreflang="en-aw" href="https://www.ibm.com/aw-en">
+<link rel="alternate" hreflang="en-au" href="https://www.ibm.com/au-en">
+<link rel="alternate" hreflang="de-at" href="https://www.ibm.com/at-de">
+<link rel="alternate" hreflang="en-bs" href="https://www.ibm.com/bs-en">
+<link rel="alternate" hreflang="en-bh" href="https://www.ibm.com/bh-en">
+<link rel="alternate" hreflang="en-bd" href="https://www.ibm.com/bd-en">
+<link rel="alternate" hreflang="en-bb" href="https://www.ibm.com/bb-en">
+<link rel="alternate" hreflang="en-be" href="https://www.ibm.com/be-en">
+<link rel="alternate" hreflang="en-bm" href="https://www.ibm.com/bm-en">
+<link rel="alternate" hreflang="es-bo" href="https://www.ibm.com/bo-es">
+<link rel="alternate" hreflang="en-bw" href="https://www.ibm.com/bw-en">
+<link rel="alternate" hreflang="pt-br" href="https://www.ibm.com/br-pt">
+<link rel="alternate" hreflang="en-vg" href="https://www.ibm.com/vg-en">
+<link rel="alternate" hreflang="en-bn" href="https://www.ibm.com/bn-en">
+<link rel="alternate" hreflang="en-bg" href="https://www.ibm.com/bg-en">
+<link rel="alternate" hreflang="fr-bf" href="https://www.ibm.com/bf-fr">
+<link rel="alternate" hreflang="en-kh" href="https://www.ibm.com/kh-en">
+<link rel="alternate" hreflang="fr-cm" href="https://www.ibm.com/cm-fr">
+<link rel="alternate" hreflang="en-ca" href="https://www.ibm.com/ca-en">
+<link rel="alternate" hreflang="fr-ca" href="https://www.ibm.com/ca-fr">
+<link rel="alternate" hreflang="en-ky" href="https://www.ibm.com/ky-en">
+<link rel="alternate" hreflang="fr-td" href="https://www.ibm.com/td-fr">
+<link rel="alternate" hreflang="es-cl" href="https://www.ibm.com/cl-es">
+<link rel="alternate" hreflang="zh-cn" href="https://www.ibm.com/cn-zh">
+<link rel="alternate" hreflang="es-co" href="https://www.ibm.com/co-es">
+<link rel="alternate" hreflang="fr-cd" href="https://www.ibm.com/cd-fr">
+<link rel="alternate" hreflang="fr-cg" href="https://www.ibm.com/cg-fr">
+<link rel="alternate" hreflang="es-cr" href="https://www.ibm.com/cr-es">
+<link rel="alternate" hreflang="en-hr" href="https://www.ibm.com/hr-en">
+<link rel="alternate" hreflang="en-cw" href="https://www.ibm.com/cw-en">
+<link rel="alternate" hreflang="en-cy" href="https://www.ibm.com/cy-en">
+<link rel="alternate" hreflang="en-cz" href="https://www.ibm.com/cz-en">
+<link rel="alternate" hreflang="en-dm" href="https://www.ibm.com/dm-en">
+<link rel="alternate" hreflang="en-dk" href="https://www.ibm.com/dk-en">
+<link rel="alternate" hreflang="es-ec" href="https://www.ibm.com/ec-es">
+<link rel="alternate" hreflang="en-eg" href="https://www.ibm.com/eg-en">
+<link rel="alternate" hreflang="en-ee" href="https://www.ibm.com/ee-en">
+<link rel="alternate" hreflang="en-et" href="https://www.ibm.com/et-en">
+<link rel="alternate" hreflang="en-fi" href="https://www.ibm.com/fi-en">
+<link rel="alternate" hreflang="fr-fr" href="https://www.ibm.com/fr-fr">
+<link rel="alternate" hreflang="fr-ga" href="https://www.ibm.com/ga-fr">
+<link rel="alternate" hreflang="de-de" href="https://www.ibm.com/de-de">
+<link rel="alternate" hreflang="en-gh" href="https://www.ibm.com/gh-en">
+<link rel="alternate" hreflang="en-gr" href="https://www.ibm.com/gr-en">
+<link rel="alternate" hreflang="en-gd" href="https://www.ibm.com/gd-en">
+<link rel="alternate" hreflang="en-gy" href="https://www.ibm.com/gy-en">
+<link rel="alternate" hreflang="en-hk" href="https://www.ibm.com/hk-en">
+<link rel="alternate" hreflang="en-hu" href="https://www.ibm.com/hu-en">
+<link rel="alternate" hreflang="en-in" href="https://www.ibm.com/in-en">
+<link rel="alternate" hreflang="en-id" href="https://www.ibm.com/id-en">
+<link rel="alternate" hreflang="en-iq" href="https://www.ibm.com/iq-en">
+<link rel="alternate" hreflang="en-ie" href="https://www.ibm.com/ie-en">
+<link rel="alternate" hreflang="en-il" href="https://www.ibm.com/il-en">
+<link rel="alternate" hreflang="it-it" href="https://www.ibm.com/it-it">
+<link rel="alternate" hreflang="fr-ci" href="https://www.ibm.com/ci-fr">
+<link rel="alternate" hreflang="en-jm" href="https://www.ibm.com/jm-en">
+<link rel="alternate" hreflang="ja-jp" href="https://www.ibm.com/jp-ja">
+<link rel="alternate" hreflang="en-jo" href="https://www.ibm.com/jo-en">
+<link rel="alternate" hreflang="en-kz" href="https://www.ibm.com/kz-en">
+<link rel="alternate" hreflang="en-ke" href="https://www.ibm.com/ke-en">
+<link rel="alternate" hreflang="ko-kr" href="https://www.ibm.com/kr-ko">
+<link rel="alternate" hreflang="en-kw" href="https://www.ibm.com/kw-en">
+<link rel="alternate" hreflang="en-lv" href="https://www.ibm.com/lv-en">
+<link rel="alternate" hreflang="en-lb" href="https://www.ibm.com/lb-en">
+<link rel="alternate" hreflang="en-ly" href="https://www.ibm.com/ly-en">
+<link rel="alternate" hreflang="en-lt" href="https://www.ibm.com/lt-en">
+<link rel="alternate" hreflang="en-mw" href="https://www.ibm.com/mw-en">
+<link rel="alternate" hreflang="en-my" href="https://www.ibm.com/my-en">
+<link rel="alternate" hreflang="fr-mu" href="https://www.ibm.com/mu-fr">
+<link rel="alternate" hreflang="es-mx" href="https://www.ibm.com/mx-es">
+<link rel="alternate" hreflang="en-ms" href="https://www.ibm.com/ms-en">
+<link rel="alternate" hreflang="fr-ma" href="https://www.ibm.com/ma-fr">
+<link rel="alternate" hreflang="pt-mz" href="https://www.ibm.com/mz-pt">
+<link rel="alternate" hreflang="en-na" href="https://www.ibm.com/na-en">
+<link rel="alternate" hreflang="en-np" href="https://www.ibm.com/np-en">
+<link rel="alternate" hreflang="en-nl" href="https://www.ibm.com/nl-en">
+<link rel="alternate" hreflang="en-nz" href="https://www.ibm.com/nz-en">
+<link rel="alternate" hreflang="fr-ne" href="https://www.ibm.com/ne-fr">
+<link rel="alternate" hreflang="en-ng" href="https://www.ibm.com/ng-en">
+<link rel="alternate" hreflang="en-no" href="https://www.ibm.com/no-en">
+<link rel="alternate" hreflang="en-om" href="https://www.ibm.com/om-en">
+<link rel="alternate" hreflang="en-pk" href="https://www.ibm.com/pk-en">
+<link rel="alternate" hreflang="es-py" href="https://www.ibm.com/py-es">
+<link rel="alternate" hreflang="es-pe" href="https://www.ibm.com/pe-es">
+<link rel="alternate" hreflang="en-ph" href="https://www.ibm.com/ph-en">
+<link rel="alternate" hreflang="pl-pl" href="https://www.ibm.com/pl-pl">
+<link rel="alternate" hreflang="en-pt" href="https://www.ibm.com/pt-en">
+<link rel="alternate" hreflang="en-qa" href="https://www.ibm.com/qa-en">
+<link rel="alternate" hreflang="en-ro" href="https://www.ibm.com/ro-en">
+<link rel="alternate" hreflang="ru-ru" href="https://www.ibm.com/ru-ru">
+<link rel="alternate" hreflang="en-kn" href="https://www.ibm.com/kn-en">
+<link rel="alternate" hreflang="en-lc" href="https://www.ibm.com/lc-en">
+<link rel="alternate" hreflang="en-vc" href="https://www.ibm.com/vc-en">
+<link rel="alternate" hreflang="en-sa" href="https://www.ibm.com/sa-en">
+<link rel="alternate" hreflang="fr-sn" href="https://www.ibm.com/sn-fr">
+<link rel="alternate" hreflang="en-rs" href="https://www.ibm.com/rs-en">
+<link rel="alternate" hreflang="fr-sc" href="https://www.ibm.com/sc-fr">
+<link rel="alternate" hreflang="en-sl" href="https://www.ibm.com/sl-en">
+<link rel="alternate" hreflang="en-sg" href="https://www.ibm.com/sg-en">
+<link rel="alternate" hreflang="en-sk" href="https://www.ibm.com/sk-en">
+<link rel="alternate" hreflang="en-si" href="https://www.ibm.com/si-en">
+<link rel="alternate" hreflang="en-za" href="https://www.ibm.com/za-en">
+<link rel="alternate" hreflang="es-es" href="https://www.ibm.com/es-es">
+<link rel="alternate" hreflang="en-lk" href="https://www.ibm.com/lk-en">
+<link rel="alternate" hreflang="en-sr" href="https://www.ibm.com/sr-en">
+<link rel="alternate" hreflang="en-se" href="https://www.ibm.com/se-en">
+<link rel="alternate" hreflang="fr-ch" href="https://www.ibm.com/ch-fr">
+<link rel="alternate" hreflang="de-ch" href="https://www.ibm.com/ch-de">
+<link rel="alternate" hreflang="zh-tw" href="https://www.ibm.com/tw-zh">
+<link rel="alternate" hreflang="en-tz" href="https://www.ibm.com/tz-en">
+<link rel="alternate" hreflang="en-th" href="https://www.ibm.com/th-en">
+<link rel="alternate" hreflang="en-tt" href="https://www.ibm.com/tt-en">
+<link rel="alternate" hreflang="fr-tn" href="https://www.ibm.com/tn-fr">
+<link rel="alternate" hreflang="tr-tr" href="https://www.ibm.com/tr-tr">
+<link rel="alternate" hreflang="en-ye" href="https://www.ibm.com/ye-en">
+<link rel="alternate" hreflang="en-tc" href="https://www.ibm.com/tc-en">
+<link rel="alternate" hreflang="en-ua" href="https://www.ibm.com/ua-en">
+<link rel="alternate" hreflang="en-ug" href="https://www.ibm.com/ug-en">
+<link rel="alternate" hreflang="en-ae" href="https://www.ibm.com/ae-en">
+<link rel="alternate" hreflang="en-gb" href="https://www.ibm.com/uk-en">
+<link rel="alternate" hreflang="es-uy" href="https://www.ibm.com/uy-es">
+<link rel="alternate" hreflang="en-uz" href="https://www.ibm.com/uz-en">
+<link rel="alternate" hreflang="es-ve" href="https://www.ibm.com/ve-es">
+<link rel="alternate" hreflang="en-vn" href="https://www.ibm.com/vn-en">
+<link rel="alternate" hreflang="en-zm" href="https://www.ibm.com/zm-en">
+<link rel="alternate" hreflang="en-zw" href="https://www.ibm.com/zw-en">
+
 <!-- IBM Tag Management and Site Analytics -->
 <script src="//1.www.s81c.com/common/stats/ibm-common.js"></script>

packages/utilities/src/utilities/altlangs/__tests__/altlangs.test.js

@@ -0,0 +1,21 @@
+import { altlangs } from '../';
+
+describe('alternative languages utility', () => {
+  it('should get all available languages on the page', () => {
+    document.body.innerHTML = `<link rel="alternate" hreflang="en-us" href="https://www.ibm.com/us-en/">
+      <link rel="alternate" hreflang="x-default" href="https://www.ibm.com">
+      <link rel="alternate" hreflang="en-af" href="https://www.ibm.com/af-en">
+      <link rel="alternate" hreflang="fr-dz" href="https://www.ibm.com/dz-fr">
+      <link rel="alternate" hreflang="pt-ao" href="https://www.ibm.com/ao-pt">`;
+
+    const output = altlangs();
+    const expected = {
+      'en-us': 'https://www.ibm.com/us-en/',
+      'x-default': 'https://www.ibm.com',
+      'en-af': 'https://www.ibm.com/af-en',
+      'fr-dz': 'https://www.ibm.com/dz-fr',
+      'pt-ao': 'https://www.ibm.com/ao-pt',
+    };
+    expect(output).toEqual(expected);
+  });
+});

packages/utilities/src/utilities/altlangs/altlangs.js

@@ -0,0 +1,29 @@
+import root from 'window-or-global';
+
+/**
+ * Utility to grab all alternative languages on the page. this scrapes the page
+ * of all <link rel="alternate" hreflang="" href="" /> elements and returns
+ * as a readable object
+ *
+ * @example
+ * import { altlangs } from '@carbon/ibmdotcom-utilities';
+ *
+ * const langs = altlangs();
+ *
+ * console.log(langs); // { 'us-en': 'https://www.ibm.com/us-en', ... }
+ *
+ * @returns {object} object of available languages and corresponding URLs
+ *
+ */
+function altlangs() {
+  const links = root.document.querySelectorAll('link[rel="alternate"]');
+  const langs = {};
+
+  links.forEach(link => {
+    langs[link.getAttribute('hreflang')] = link.getAttribute('href');
+  });
+
+  return langs;
+}
+
+export default altlangs;

packages/utilities/src/utilities/altlangs/index.js

@@ -0,0 +1,8 @@
+/**
+ * Copyright IBM Corp. 2016, 2018
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+export { default as altlangs } from './altlangs';

packages/utilities/src/utilities/index.js

@@ -5,6 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+export * from './altlangs';
 export * from './escaperegexp';
 export * from './featureflag';
 export * from './geolocation';