libphonenumber-metadata-generator/modules/download.js

Metadata generator for `libphonenumber-js`

function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }

function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }

function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }

function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }

function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } return _assertThisInitialized(self); }

function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }

function _wrapNativeSuper(Class) { var _cache = typeof Map === "function" ? new Map() : undefined; _wrapNativeSuper = function _wrapNativeSuper(Class) { if (Class === null || !_isNativeFunction(Class)) return Class; if (typeof Class !== "function") { throw new TypeError("Super expression must either be null or a function"); } if (typeof _cache !== "undefined") { if (_cache.has(Class)) return _cache.get(Class); _cache.set(Class, Wrapper); } function Wrapper() { return _construct(Class, arguments, _getPrototypeOf(this).constructor); } Wrapper.prototype = Object.create(Class.prototype, { constructor: { value: Wrapper, enumerable: false, writable: true, configurable: true } }); return _setPrototypeOf(Wrapper, Class); }; return _wrapNativeSuper(Class); }

function _construct(Parent, args, Class) { if (_isNativeReflectConstruct()) { _construct = Reflect.construct; } else { _construct = function _construct(Parent, args, Class) { var a = [null]; a.push.apply(a, args); var Constructor = Function.bind.apply(Parent, a); var instance = new Constructor(); if (Class) _setPrototypeOf(instance, Class.prototype); return instance; }; } return _construct.apply(null, arguments); }

function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }

function _isNativeFunction(fn) { return Function.toString.call(fn).indexOf("[native code]") !== -1; }

function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }

function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }

function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }

function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }

function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }

import parseReleaseNotes from './parseReleaseNotes';
import downloadFile from './downloadFile'; // Downloads `PhoneNumberMetadata.xml` file from Google's `libphonenumber` GitHub repository.

export default function downloadPhoneNumberMetadataXml() {
  return downloadPhoneNumberMetadataXmlForLatestReleaseFromGitHub();
} // This is what `raw.githubusercontent.com` server returns with HTTP status code 200
// when requesting a file that doesn't exist.

var FILE_NOT_FOUND_RESPONSE_CONTENT = '404: Not Found';
var TOO_MANY_REQUESTS_RESPONSE_CONTENT = '429: Too Many Requests\nFor more on scraping GitHub and how it may affect your rights, please review our Terms of Service (https://docs.github.com/en/site-policy/github-terms/github-terms-of-service).';
var RELEASE_NOTES_URL = 'https://raw.githubusercontent.com/googlei18n/libphonenumber/master/release_notes.txt';
var GOOGLE_REPOSITORY_TAG_NAME_TEMPLATE = 'v{version}';
var METADATA_XML_URL_TEMPLATE = 'https://raw.githubusercontent.com/google/libphonenumber/refs/tags/{tag}/resources/PhoneNumberMetadata.xml'; // Downloads the latest released revision of `PhoneNumberMetadata.xml` file from Google's GitHub releases.

function downloadPhoneNumberMetadataXmlForLatestReleaseFromGitHub() {
  // console.log('Downloading `release_notes.txt` file from Google\'s `libphonenumber` GitHub repository')
  return downloadFile(RELEASE_NOTES_URL).then(function (releaseNotes) {
    if (releaseNotes === FILE_NOT_FOUND_RESPONSE_CONTENT) {
      throw new FileNotFoundError('`release_notes.txt` file was not found in Google\'s `libphonenumber` GitHub repository', RELEASE_NOTES_URL);
    }

    if (releaseNotes === TOO_MANY_REQUESTS_RESPONSE_CONTENT) {
      throw new TooManyRequestsError('Couldn\'t download `release_notes.txt` from Google\'s `libphonenumber` GitHub repository. The download was blocked by GitHub\'s anti-scraping mechanism. The error was: "Too Many Requests".', RELEASE_NOTES_URL);
    } // Read the latest version's entry in the release notes.


    var releasedVersionsInfo = parseReleaseNotes(releaseNotes); // If not a single release notes entry has been parsed, throw an error.

    if (releasedVersionsInfo.length === 0) {
      throw new Error('Couldn\'t parse released versions\' entries from `release_notes.txt` in Google\'s `libphonenumber` GitHub repository');
    } // console.log('Latest released version of Google\'s `libphonenumber`: ' + releasedVersionsInfo[0].version)
    // console.log('Downloading `PhoneNumberMetadata.xml` for that version')
    // Download metadata XML.
    //
    // It has been pointed out that a release version "tag" in the git repository usually gets created with a delay
    // that could be up to a couple of hours: https://gitlab.com/catamphetamine/libphonenumber-metadata-generator/-/issues/4
    //
    // A workaround is to attempt to download the latest release metadata
    // and then fall back to the previous release metadata.
    //


    return downloadMetadataXmlForReleaseVersion(releasedVersionsInfo[0].version).then( // If the latest release metadata file exists then return the result.
    function (xml) {
      return _objectSpread(_objectSpread({}, releasedVersionsInfo[0]), {}, {
        xml: xml
      });
    }, function (error) {
      // If the latest release metadata file was not found,
      // it's likely to the git "tag" not having been created yet.
      if (error instanceof FileNotFoundError) {
        // If there's no previous release then exit with an error.
        if (releasedVersionsInfo.length === 1) {
          throw error;
        } // Fall back to the previous release metadata.


        return downloadMetadataXmlForReleaseVersion(releasedVersionsInfo[1].version).then( // If the previous release metadata file exists then return the result.
        function (xml) {
          return _objectSpread(_objectSpread({}, releasedVersionsInfo[1]), {}, {
            xml: xml
          });
        }, function (error) {
          // If the prevoius release metadata file was not found
          // then it seems like some kind of an unusual error.
          if (error instanceof FileNotFoundError) {
            throw new Error("Neither tag \"".concat(GOOGLE_REPOSITORY_TAG_NAME_TEMPLATE.replace('{version}', releasedVersionsInfo[0].version), "\" nor tag \"").concat(GOOGLE_REPOSITORY_TAG_NAME_TEMPLATE.replace('{version}', releasedVersionsInfo[1].version), "\" were found in Google's `libphonenumber` GitHub repository. This is not supposed to happen."));
          } else {
            throw error;
          }
        });
      } else {
        throw error;
      }
    });
  });
} // Downloads the latest `PhoneNumberMetadata.xml` file from Google's GitHub repository,
// regardless of whether this XML file has been released yet or not.


function downloadPhoneNumberMetadataXmlFromGitHub() {
  // console.log('Downloading latest `PhoneNumberMetadata.xml` from Google\'s `libphonenumber` GitHub repository')
  return download('https://raw.githubusercontent.com/googlei18n/libphonenumber/master/resources/PhoneNumberMetadata.xml').then(function (xml) {
    return {
      version: 'latest',
      changes: [],
      xml: xml
    };
  });
}

function downloadMetadataXmlForReleaseVersion(version) {
  // Download `PhoneNumberMetadata.xml` file from the GitHub repo "tag" that corresponds to the latest released version.
  //
  // It has been pointed out that a release version "tag" in the git repository usually gets created with a delay
  // that could be up to a couple of hours: https://gitlab.com/catamphetamine/libphonenumber-metadata-generator/-/issues/4
  //
  var tag = GOOGLE_REPOSITORY_TAG_NAME_TEMPLATE.replace('{version}', version);
  var metadataXmlUrl = METADATA_XML_URL_TEMPLATE.replace('{tag}', tag);
  return downloadFile(metadataXmlUrl).then(function (xml) {
    if (xml === FILE_NOT_FOUND_RESPONSE_CONTENT) {
      throw new FileNotFoundError("Tag \"v".concat(version, "\" was not found in Google's `libphonenumber` GitHub repository. Perhaps it hasn't been created yet. Try again later."), metadataXmlUrl);
    }

    if (xml === TOO_MANY_REQUESTS_RESPONSE_CONTENT) {
      throw new TooManyRequestsError("Couldn't download files from \"v".concat(version, "\" tag of Google's `libphonenumber` GitHub repository. The download was blocked by GitHub's anti-scraping mechanism. The error was: \"Too Many Requests\"."), RELEASE_NOTES_URL);
    }

    return xml;
  });
}

var FileNotFoundError = /*#__PURE__*/function (_Error) {
  _inherits(FileNotFoundError, _Error);

  var _super = _createSuper(FileNotFoundError);

  function FileNotFoundError(message, url) {
    var _this;

    _classCallCheck(this, FileNotFoundError);

    _this = _super.call(this, message);
    _this.url = url;
    return _this;
  }

  return FileNotFoundError;
}( /*#__PURE__*/_wrapNativeSuper(Error));

var TooManyRequestsError = /*#__PURE__*/function (_Error2) {
  _inherits(TooManyRequestsError, _Error2);

  var _super2 = _createSuper(TooManyRequestsError);

  function TooManyRequestsError(message, url) {
    var _this2;

    _classCallCheck(this, TooManyRequestsError);

    _this2 = _super2.call(this, message);
    _this2.url = url;
    return _this2;
  }

  return TooManyRequestsError;
}( /*#__PURE__*/_wrapNativeSuper(Error));
//# sourceMappingURL=download.js.map