@containerbase/base 14.63.0 → 14.63.1

package/README.md

@@ -112,8 +112,9 @@ A reader can replace its urls the same way, so a mirror configured for container
 ```ts
 import { getUrlReplacements, replaceUrl } from '@containerbase/base';
 
-const { replacements, invalid } = getUrlReplacements(); // reads `process.env`
-// `invalid` lists the `URL_REPLACE_<n>_FROM` variables without a value or `_TO` counterpart
+const { replacements, invalid, withoutScheme } = getUrlReplacements(); // reads `process.env`
+// `invalid` lists the `URL_REPLACE_<n>_FROM` variables without a value or `_TO` counterpart,
+// `withoutScheme` the ones whose value doesn't start with `http://` or `https://`
 replaceUrl(
   'https://containerbase.github.io/tool-versions/v1/node.json',
   replacements,
@@ -121,9 +122,8 @@ replaceUrl(
 );
 ```
 
-`replaceUrl` replaces the first occurrence of a `from` anywhere in the url; the next major only matches at the start of the url, see [#8160](https://github.com/containerbase/base/issues/8160).
-`replaceUrlPrefix(url, rules)` already does: the rules apply in order, each to the result of the previous ones, and only when the url starts with its `from`.
-It has no cdn step and returns the replaced url with the rules that matched, other fields of the rules are kept.
+`replaceUrl` applies the cdn first, then the replacements like `replaceUrlPrefix(url, rules)`: in order, each to the result of the previous ones, and only when the url starts with its `from`.
+`replaceUrlPrefix` has no cdn step and returns the replaced url with the rules that matched, other fields of the rules are kept.
 End `from` and `to` with a `/`, like `https://example.com/`, so a rule only matches that host: `https://example.com` also matches `https://example.com.test/`.
 
 ```ts

package/dist/url.d.ts

@@ -9,6 +9,12 @@ export interface UrlReplacements {
      * their `URL_REPLACE_<n>_TO` counterpart are empty or missing.
      */
     invalid: string[];
+    /**
+     * The `URL_REPLACE_<n>_FROM` variables whose value doesn't start with
+     * `http://` or `https://`, like a bare host. They are used, but only match
+     * urls which start with them.
+     */
+    withoutScheme: string[];
 }
 /**
  * Reads the url replacements from the `URL_REPLACE_<n>_FROM` and
@@ -20,8 +26,9 @@ export declare function getUrlReplacements(env?: Record<string, string | undefin
 /**
  * Replaces a url the way containerbase does for its downloads: with a `cdn`,
  * `https://` is replaced by it first, eg. `https://example.com/file` becomes
- * `<cdn>/example.com/file`. Then every replacement is applied in order, each
- * replacing the first occurrence of its `from` text.
+ * `<cdn>/example.com/file`. Then the replacements are applied in order like
+ * `replaceUrlPrefix`, each to the result of the previous ones and only when
+ * the url starts with its `from`.
  *
  * @param url the url to replace
  * @param replacements the replacements, see `getUrlReplacements`
@@ -46,8 +53,8 @@ export interface UrlPrefixResult<T extends UrlPrefixRule> {
 /**
  * Replaces url prefixes: the rules are applied in order, each one to the
  * result of the previous ones, and a rule only applies when the url starts
- * with its `from`, which is then replaced by its `to`. Unlike `replaceUrl`,
- * a `from` elsewhere in the url never matches, and there is no cdn. End `from`
+ * with its `from`, which is then replaced by its `to`. A `from` elsewhere in
+ * the url never matches, and unlike `replaceUrl` there is no cdn. End `from`
  * and `to` with a `/`, like `https://example.com/`, so a rule only matches that
  * host: `https://example.com` also matches `https://example.com.test/`.
  *

package/dist/url.js

@@ -1,4 +1,5 @@
 const fromRe = /^URL_REPLACE_\d+_FROM$/;
+const schemeRe = /^https?:\/\//;
 const collator = new Intl.Collator('en', {
     sensitivity: 'base',
     numeric: true,
@@ -10,7 +11,11 @@ const collator = new Intl.Collator('en', {
  * @param env the environment to read, `process.env` by default
  */
 export function getUrlReplacements(env = process.env) {
-    const result = { replacements: [], invalid: [] };
+    const result = {
+        replacements: [],
+        invalid: [],
+        withoutScheme: [],
+    };
     for (const from of Object.keys(env)
         .filter((key) => fromRe.test(key))
         .sort((a, b) => collator.compare(a, b))) {
@@ -19,6 +24,9 @@ export function getUrlReplacements(env = process.env) {
         const toValue = env[to];
         if (fromValue && toValue) {
             result.replacements.push([fromValue, toValue]);
+            if (!schemeRe.test(fromValue)) {
+                result.withoutScheme.push(from);
+            }
         }
         else {
             result.invalid.push(from);
@@ -29,30 +37,27 @@ export function getUrlReplacements(env = process.env) {
 /**
  * Replaces a url the way containerbase does for its downloads: with a `cdn`,
  * `https://` is replaced by it first, eg. `https://example.com/file` becomes
- * `<cdn>/example.com/file`. Then every replacement is applied in order, each
- * replacing the first occurrence of its `from` text.
+ * `<cdn>/example.com/file`. Then the replacements are applied in order like
+ * `replaceUrlPrefix`, each to the result of the previous ones and only when
+ * the url starts with its `from`.
  *
  * @param url the url to replace
  * @param replacements the replacements, see `getUrlReplacements`
  * @param cdn the cdn url, eg. from `CONTAINERBASE_CDN`, skipped when empty
  * @returns the replaced url
  */
-// TODO: match only at the start of the url in the next major, like `replaceUrlPrefix` (#8160)
 export function replaceUrl(url, replacements, cdn) {
     let result = url;
     if (cdn) {
         result = result.replace(/^https:\//, cdn.replace(/\/$/, ''));
     }
-    for (const [from, to] of replacements) {
-        result = result.replace(from, to);
-    }
-    return result;
+    return replaceUrlPrefix(result, replacements.map(([from, to]) => ({ from, to }))).url;
 }
 /**
  * Replaces url prefixes: the rules are applied in order, each one to the
  * result of the previous ones, and a rule only applies when the url starts
- * with its `from`, which is then replaced by its `to`. Unlike `replaceUrl`,
- * a `from` elsewhere in the url never matches, and there is no cdn. End `from`
+ * with its `from`, which is then replaced by its `to`. A `from` elsewhere in
+ * the url never matches, and unlike `replaceUrl` there is no cdn. End `from`
  * and `to` with a `/`, like `https://example.com/`, so a rule only matches that
  * host: `https://example.com` also matches `https://example.com.test/`.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@containerbase/base",
-  "version": "14.63.0",
+  "version": "14.63.1",
   "description": "Metadata about the tools supported by containerbase",
   "keywords": [
     "containerbase",