@containerbase/base 14.53.0 → 14.55.0

package/README.md

@@ -121,6 +121,19 @@ replaceUrl(
 );
 ```
 
+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:
+
+```ts
+import { filterByMinCb, packageVersion } from '@containerbase/base';
+import type { ToolVersions } from '@containerbase/base';
+
+declare const data: ToolVersions; // the content of eg. `node.json`
+
+const { versions, needed } = filterByMinCb(data, packageVersion);
+```
+
 The schemas ignore unknown keys and accept any arch name, so additive changes of the format don't break a reader; readers ignore files of an arch they don't know.
 
 ## Contents

package/dist/index.d.ts

@@ -3,6 +3,8 @@ import type { DistroCode } from './types.ts';
 export type { Arch, DistroCode, InstallToolType, ToolMetadata, ToolType, } from './types.ts';
 export type { FileIntegrity, FileReference, FormatIndex, ToolFile, ToolIndex, ToolVersion, ToolVersions, VersionFiles, VersionIntegrity, } from './tool-versions-types.ts';
 export { containerbaseVersionFile, isCompatibleVersion, isContainerbase, packageVersion, toolVersionsPath, validateContainerbaseVersion, } from './containerbase.ts';
+export { filterByMinCb } 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';

package/dist/index.js

@@ -1,5 +1,7 @@
 import { tools } from "./data.js";
 export { containerbaseVersionFile, isCompatibleVersion, isContainerbase, packageVersion, toolVersionsPath, validateContainerbaseVersion, } from "./containerbase.js";
+export { filterByMinCb } 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 { tools };

package/dist/min-cb.d.ts

@@ -0,0 +1,20 @@
+import type { ToolVersion, ToolVersions } from './tool-versions-types.ts';
+/**
+ * Filters the versions of a tool by the `minCb` ranges of its data, to the
+ * releases the given containerbase version can install.
+ *
+ * The data lists the newest release first. A range covers its `version` and
+ * every version above it in the data, prereleases count for the position. A
+ * range whose `version` is not listed is ignored. A range is met when its `cb`
+ * is valid semver and the containerbase version is the same or newer, a `cb`
+ * which is not valid semver is never met. A containerbase version which is not
+ * a release, like the development build `0.0.0-PLACEHOLDER`, skips the filter.
+ * @param data - the tool-versions data of a tool
+ * @param cbVersion - the containerbase version
+ * @returns the installable `versions` in the order of the data, and the `cb`
+ * values of the unmet ranges as `needed`
+ */
+export declare function filterByMinCb(data: ToolVersions, cbVersion: string): {
+    versions: ToolVersion[];
+    needed: string[];
+};

package/dist/min-cb.js

@@ -0,0 +1,35 @@
+import semverGte from 'semver/functions/gte.js';
+import semverValid from 'semver/functions/valid.js';
+import { isReleaseVersion } from "./release-version.js";
+/**
+ * Filters the versions of a tool by the `minCb` ranges of its data, to the
+ * releases the given containerbase version can install.
+ *
+ * The data lists the newest release first. A range covers its `version` and
+ * every version above it in the data, prereleases count for the position. A
+ * range whose `version` is not listed is ignored. A range is met when its `cb`
+ * is valid semver and the containerbase version is the same or newer, a `cb`
+ * which is not valid semver is never met. A containerbase version which is not
+ * a release, like the development build `0.0.0-PLACEHOLDER`, skips the filter.
+ * @param data - the tool-versions data of a tool
+ * @param cbVersion - the containerbase version
+ * @returns the installable `versions` in the order of the data, and the `cb`
+ * values of the unmet ranges as `needed`
+ */
+export function filterByMinCb(data, cbVersion) {
+    // the versions up to this index need a newer containerbase: a range which
+    // isn't met covers all versions from its start up to the newest one
+    let unmet = -1;
+    const needed = [];
+    if (isReleaseVersion(cbVersion)) {
+        for (const range of data.minCb ?? []) {
+            const start = data.versions.findIndex((v) => v.version === range.version);
+            if (start >= 0 &&
+                !(semverValid(range.cb) !== null && semverGte(cbVersion, range.cb))) {
+                unmet = Math.max(unmet, start);
+                needed.push(range.cb);
+            }
+        }
+    }
+    return { versions: data.versions.slice(unmet + 1), needed };
+}

package/package.json

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