@containerbase/base 14.62.0 → 14.63.0

package/README.md

@@ -121,6 +121,20 @@ 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.
+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
+import { replaceUrlPrefix } from '@containerbase/base';
+
+const { url, applied } = replaceUrlPrefix('https://registry.npmjs.org/foo', [
+  { from: 'https://registry.npmjs.org/', to: 'https://npm.example.test/' },
+]);
+// url: 'https://npm.example.test/foo', applied: [the rule]
+```
+
 A tool's data may list `minCb` ranges, the oldest containerbase version which can install a version and every version above it.
 `filterByMinCb(data, cbVersion)` returns the `versions` the given containerbase version can install, in the order of the data, and the `cb` values of the unmet ranges as `needed`.
 A `cbVersion` which isn't a release, like `0.0.0-PLACEHOLDER` (see `isReleaseVersion(version)`), skips the filter:

package/dist/index.d.ts

@@ -8,8 +8,8 @@ export { configure, getLogger, isConfigured } from './logger.ts';
 export { filterByMinCb, minCbByVersion } from './min-cb.ts';
 export { isReleaseVersion } from './release-version.ts';
 export { isToolVersionsFormat, toolVersionsFormat, toolVersionsFormatPath, } from './tool-versions-format.ts';
-export type { UrlReplacement, UrlReplacements } from './url.ts';
-export { getUrlReplacements, replaceUrl } from './url.ts';
+export type { UrlPrefixResult, UrlPrefixRule, UrlReplacement, UrlReplacements, } from './url.ts';
+export { getUrlReplacements, replaceUrl, replaceUrlPrefix } from './url.ts';
 export { tools };
 /**
  * The Ubuntu release the default containerbase image is built from, the

package/dist/index.js

@@ -4,7 +4,7 @@ export { configure, getLogger, isConfigured } from "./logger.js";
 export { filterByMinCb, minCbByVersion } from "./min-cb.js";
 export { isReleaseVersion } from "./release-version.js";
 export { isToolVersionsFormat, toolVersionsFormat, toolVersionsFormatPath, } from "./tool-versions-format.js";
-export { getUrlReplacements, replaceUrl } from "./url.js";
+export { getUrlReplacements, replaceUrl, replaceUrlPrefix } from "./url.js";
 export { tools };
 /**
  * The Ubuntu release the default containerbase image is built from, the

package/dist/url.d.ts

@@ -29,3 +29,30 @@ export declare function getUrlReplacements(env?: Record<string, string | undefin
  * @returns the replaced url
  */
 export declare function replaceUrl(url: string, replacements: readonly UrlReplacement[], cdn?: string): string;
+/** A url prefix replacement rule, other fields are kept as they are. */
+export interface UrlPrefixRule {
+    /** The url prefix to replace. */
+    from: string;
+    /** Its replacement. */
+    to: string;
+}
+/** The result of `replaceUrlPrefix`. */
+export interface UrlPrefixResult<T extends UrlPrefixRule> {
+    /** The replaced url. */
+    url: string;
+    /** The rules which matched, in order. */
+    applied: T[];
+}
+/**
+ * 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`
+ * and `to` with a `/`, like `https://example.com/`, so a rule only matches that
+ * host: `https://example.com` also matches `https://example.com.test/`.
+ *
+ * @param url the url to replace
+ * @param rules the rules, in order
+ * @returns the replaced url and the rules which matched
+ */
+export declare function replaceUrlPrefix<T extends UrlPrefixRule>(url: string, rules: readonly T[]): UrlPrefixResult<T>;

package/dist/url.js

@@ -37,6 +37,7 @@ export function getUrlReplacements(env = process.env) {
  * @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) {
@@ -47,3 +48,26 @@ export function replaceUrl(url, replacements, cdn) {
     }
     return result;
 }
+/**
+ * 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`
+ * and `to` with a `/`, like `https://example.com/`, so a rule only matches that
+ * host: `https://example.com` also matches `https://example.com.test/`.
+ *
+ * @param url the url to replace
+ * @param rules the rules, in order
+ * @returns the replaced url and the rules which matched
+ */
+export function replaceUrlPrefix(url, rules) {
+    let result = url;
+    const applied = [];
+    for (const rule of rules) {
+        if (result.startsWith(rule.from)) {
+            result = rule.to + result.slice(rule.from.length);
+            applied.push(rule);
+        }
+    }
+    return { url: result, applied };
+}

package/package.json

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