@containerbase/base 14.43.0 → 14.44.0

package/README.md

@@ -55,6 +55,25 @@ import { ToolVersions } from '@containerbase/base/zod';
 import type { ToolVersions as ToolVersionsType } from '@containerbase/base';
 ```
 
+The format version the schemas describe is exported by both entry points, so a reader doesn't hardcode it:
+
+```ts
+import {
+  isToolVersionsFormat,
+  toolVersionsFormat,
+  toolVersionsFormatPath,
+} from '@containerbase/base';
+
+toolVersionsFormat; // 1
+toolVersionsFormatPath; // 'v1', the folder of the format relative to the site root
+isToolVersionsFormat(
+  'https://containerbase.github.io/tool-versions/v1/tool.schema.json',
+); // true
+isToolVersionsFormat(
+  'https://containerbase.github.io/tool-versions/v2/tool.schema.json',
+); // false
+```
+
 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

@@ -2,6 +2,7 @@ import { tools } from './data.ts';
 import type { DistroCode } from './types.ts';
 export type { DistroCode, InstallToolType, ToolMetadata, ToolType, } from './types.ts';
 export type { FileIntegrity, FileReference, FormatIndex, ToolFile, ToolIndex, ToolVersion, ToolVersions, VersionFiles, VersionIntegrity, } from './tool-versions-types.ts';
+export { isToolVersionsFormat, toolVersionsFormat, toolVersionsFormatPath, } from './tool-versions-format.ts';
 export { tools };
 /**
  * The Ubuntu release the default containerbase image is built from, the

package/dist/index.js

@@ -1,4 +1,5 @@
 import { tools } from "./data.js";
+export { isToolVersionsFormat, toolVersionsFormat, toolVersionsFormatPath, } from "./tool-versions-format.js";
 export { tools };
 /**
  * The Ubuntu release the default containerbase image is built from, the

package/dist/tool-versions-format.d.ts

@@ -0,0 +1,24 @@
+/**
+ * The major version of the tool-versions format the schemas of this package
+ * describe.
+ */
+export declare const toolVersionsFormat = 1;
+/**
+ * The folder of the format relative to the root of the published
+ * tool-versions site, eg. `v1`, for building urls.
+ * To pick the format from the root index, match its `version` against
+ * `toolVersionsFormat`; its `path` is `v1/`.
+ */
+export declare const toolVersionsFormatPath = "v1";
+/**
+ * Checks if the `$schema` url of a tool-versions file names a schema of the
+ * format this package describes, eg.
+ * `https://containerbase.github.io/tool-versions/v1/tool.schema.json`.
+ * Only the path of the url is checked, its query and fragment are ignored.
+ * The protocol and host are not checked, so mirrors work too.
+ *
+ * @param schemaUrl the `$schema` value of the file
+ * @returns `false` for the schema of another format, an invalid url or a
+ * missing value
+ */
+export declare function isToolVersionsFormat(schemaUrl: string | undefined): boolean;

package/dist/tool-versions-format.js

@@ -0,0 +1,35 @@
+/**
+ * The major version of the tool-versions format the schemas of this package
+ * describe.
+ */
+export const toolVersionsFormat = 1;
+/**
+ * The folder of the format relative to the root of the published
+ * tool-versions site, eg. `v1`, for building urls.
+ * To pick the format from the root index, match its `version` against
+ * `toolVersionsFormat`; its `path` is `v1/`.
+ */
+export const toolVersionsFormatPath = `v${toolVersionsFormat}`;
+const schemaUrlPattern = new RegExp(`/${toolVersionsFormatPath}/[^/]+\\.schema\\.json$`);
+/**
+ * Checks if the `$schema` url of a tool-versions file names a schema of the
+ * format this package describes, eg.
+ * `https://containerbase.github.io/tool-versions/v1/tool.schema.json`.
+ * Only the path of the url is checked, its query and fragment are ignored.
+ * The protocol and host are not checked, so mirrors work too.
+ *
+ * @param schemaUrl the `$schema` value of the file
+ * @returns `false` for the schema of another format, an invalid url or a
+ * missing value
+ */
+export function isToolVersionsFormat(schemaUrl) {
+    if (schemaUrl === undefined) {
+        return false;
+    }
+    try {
+        return schemaUrlPattern.test(new URL(schemaUrl).pathname);
+    }
+    catch {
+        return false;
+    }
+}

package/dist/zod.d.ts

@@ -1,5 +1,6 @@
 import { z } from 'zod';
 export * from './schema.ts';
+export * from './tool-versions-format.ts';
 export * from './tool-versions-schema.ts';
 /**
  * Enum of all tool names supported by the containerbase version this package

package/dist/zod.js

@@ -1,6 +1,7 @@
 import { z } from 'zod';
 import { toolNames } from "./index.js";
 export * from "./schema.js";
+export * from "./tool-versions-format.js";
 export * from "./tool-versions-schema.js";
 /**
  * Enum of all tool names supported by the containerbase version this package

package/package.json

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