source: frontend/node_modules/workbox-precaching/src/utils/generateURLVariations.ts

/*
  Copyright 2019 Google LLC

  Use of this source code is governed by an MIT-style
  license that can be found in the LICENSE file or at
  https://opensource.org/licenses/MIT.
*/

import {removeIgnoredSearchParams} from './removeIgnoredSearchParams.js';
import {PrecacheRouteOptions} from '../_types.js';
import '../_version.js';

/**
 * Generator function that yields possible variations on the original URL to
 * check, one at a time.
 *
 * @param {string} url
 * @param {Object} options
 *
 * @private
 * @memberof workbox-precaching
 */
export function* generateURLVariations(
  url: string,
  {
    ignoreURLParametersMatching = [/^utm_/, /^fbclid$/],
    directoryIndex = 'index.html',
    cleanURLs = true,
    urlManipulation,
  }: PrecacheRouteOptions = {},
): Generator<string, void, unknown> {
  const urlObject = new URL(url, location.href);
  urlObject.hash = '';
  yield urlObject.href;

  const urlWithoutIgnoredParams = removeIgnoredSearchParams(
    urlObject,
    ignoreURLParametersMatching,
  );
  yield urlWithoutIgnoredParams.href;

  if (directoryIndex && urlWithoutIgnoredParams.pathname.endsWith('/')) {
    const directoryURL = new URL(urlWithoutIgnoredParams.href);
    directoryURL.pathname += directoryIndex;
    yield directoryURL.href;
  }

  if (cleanURLs) {
    const cleanURL = new URL(urlWithoutIgnoredParams.href);
    cleanURL.pathname += '.html';
    yield cleanURL.href;
  }

  if (urlManipulation) {
    const additionalURLs = urlManipulation({url: urlObject});
    for (const urlToAttempt of additionalURLs) {
      yield urlToAttempt.href;
    }
  }
}