@containerbase/base 14.24.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 WhiteSource Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,58 @@
+# `@containerbase/base`
+
+Metadata about the tools that [Containerbase](https://github.com/containerbase/base) supports.
+
+The data is generated from the Containerbase sources and released with the same version as Containerbase itself.
+This allows a consumer of this library to determine which tools can be used with a given version of Containerbase (via `/usr/local/containerbase/version`): if the image has the same major version as this package and a version greater than or equal to the package version, every tool listed here can be installed in that image.
+A new major version may remove tools, so compare against the package of the image's major version.
+
+The package version to compare with is exported too:
+
+```ts
+import pkg from '@containerbase/base/package.json' with { type: 'json' };
+
+pkg.version; // eg. '14.2.0'
+```
+
+## Usage
+
+```ts
+import { toolNames, tools, type ToolName } from '@containerbase/base';
+
+tools.composer; // { parent: 'php' }
+tools.kas; // { type: 'pip', parent: 'python' }
+
+function install(tool: ToolName): void {
+  // `ToolName` is a union of all supported names
+}
+```
+
+The raw data and its json schema are also exported, for consumers which don't use TypeScript:
+
+```ts
+import tools from '@containerbase/base/tools.json' with { type: 'json' };
+```
+
+The zod schemas live behind a separate entry point, so the default export stays dependency free:
+
+```ts
+import { SupportedTools, ToolName } from '@containerbase/base/zod';
+```
+
+## Contents
+
+Each entry may carry the following metadata:
+
+| Field        | Description                                                                                                     |
+| ------------ | --------------------------------------------------------------------------------------------------------------- |
+| `type`       | the installer used for the tool, one of `gem`, `npm` or `pip`                                                   |
+| `parent`     | the tool it depends on, eg. `composer` depends on `php`, which requires `php` to be installed before `composer` |
+| `deprecated` | the tool should not be used any more                                                                            |
+| `root`       | the tool can only be installed as root, so at image build time                                                  |
+
+Only the names `install-tool` accepts are listed.
+Packages installed with an arbitrary name via `install-gem`, `install-npm` or `install-pip` are not, as that list is unbounded.
+
+## Development
+
+The files in `data/` and `src/data.ts` are generated, run `pnpm tools` in the repository root to update them.

package/data/tools.json

@@ -0,0 +1,81 @@
+{
+  "tools": {
+    "android-sdk-cmdline-tools": { "parent": "java" },
+    "apko": {},
+    "apm": {},
+    "bazelisk": {},
+    "bower": { "type": "npm", "parent": "node", "deprecated": true },
+    "buf": {},
+    "buildx": { "parent": "docker" },
+    "bun": {},
+    "bundler": { "type": "gem", "parent": "ruby" },
+    "cabal": {},
+    "checkov": { "type": "pip", "parent": "python" },
+    "cocoapods": { "parent": "ruby" },
+    "composer": { "parent": "php" },
+    "conan": { "parent": "python" },
+    "copier": { "type": "pip", "parent": "python" },
+    "corepack": { "type": "npm", "parent": "node" },
+    "dart": {},
+    "deno": {},
+    "devbox": {},
+    "docker": {},
+    "docker-compose": { "parent": "docker" },
+    "dotnet": {},
+    "elixir": { "parent": "erlang" },
+    "erlang": {},
+    "flutter": {},
+    "flux": {},
+    "gh": {},
+    "ghc": {},
+    "git": { "root": true },
+    "git-lfs": { "parent": "git" },
+    "gleam": {},
+    "golang": {},
+    "gradle": { "parent": "java" },
+    "hashin": { "type": "pip", "parent": "python" },
+    "helm": {},
+    "helmfile": {},
+    "java": {},
+    "java-jdk": {},
+    "java-jre": {},
+    "jb": {},
+    "kas": { "type": "pip", "parent": "python" },
+    "kubectl": {},
+    "kustomize": {},
+    "lerna": { "type": "npm", "parent": "node", "deprecated": true },
+    "maven": { "parent": "java" },
+    "mise": {},
+    "mono": {},
+    "nix": {},
+    "node": {},
+    "npm": { "type": "npm", "parent": "node" },
+    "nuget": { "parent": "mono" },
+    "paket": { "parent": "dotnet" },
+    "pdm": { "type": "pip", "parent": "python" },
+    "php": {},
+    "pip-tools": { "type": "pip", "parent": "python" },
+    "pipenv": { "type": "pip", "parent": "python" },
+    "pixi": {},
+    "pnpm": { "type": "npm", "parent": "node" },
+    "poetry": { "type": "pip", "parent": "python" },
+    "powershell": {},
+    "protoc": {},
+    "python": {},
+    "renovate": { "parent": "node" },
+    "ruby": {},
+    "rust": {},
+    "sbt": { "parent": "java" },
+    "scala": { "parent": "java" },
+    "skopeo": {},
+    "sops": {},
+    "swift": {},
+    "terraform": {},
+    "tofu": {},
+    "uv": { "type": "pip", "parent": "python" },
+    "vendir": {},
+    "wally": {},
+    "yarn": { "parent": "node" },
+    "yarn-slim": { "parent": "node" }
+  }
+}

package/data/tools.schema.json

@@ -0,0 +1,38 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "tools": {
+      "type": "object",
+      "propertyNames": { "type": "string" },
+      "additionalProperties": {
+        "type": "object",
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": ["gem", "npm", "pip"],
+            "description": "the installer used for this tool, only set for dynamically installed tools"
+          },
+          "parent": {
+            "type": "string",
+            "description": "the tool this tool depends on, eg. composer depends on php"
+          },
+          "deprecated": {
+            "type": "boolean",
+            "const": true,
+            "description": "deprecated tools should not be used any more"
+          },
+          "root": {
+            "type": "boolean",
+            "const": true,
+            "description": "the tool can only be installed as root, so only at image build time"
+          }
+        },
+        "additionalProperties": false
+      },
+      "description": "all supported tools, keyed by tool name"
+    }
+  },
+  "required": ["tools"],
+  "additionalProperties": false
+}

package/dist/data.d.ts

@@ -0,0 +1,165 @@
+/**
+ * All tools `install-tool` supports, sorted by name.
+ */
+export declare const tools: {
+    readonly 'android-sdk-cmdline-tools': {
+        readonly parent: "java";
+    };
+    readonly apko: {};
+    readonly apm: {};
+    readonly bazelisk: {};
+    readonly bower: {
+        readonly type: "npm";
+        readonly parent: "node";
+        readonly deprecated: true;
+    };
+    readonly buf: {};
+    readonly buildx: {
+        readonly parent: "docker";
+    };
+    readonly bun: {};
+    readonly bundler: {
+        readonly type: "gem";
+        readonly parent: "ruby";
+    };
+    readonly cabal: {};
+    readonly checkov: {
+        readonly type: "pip";
+        readonly parent: "python";
+    };
+    readonly cocoapods: {
+        readonly parent: "ruby";
+    };
+    readonly composer: {
+        readonly parent: "php";
+    };
+    readonly conan: {
+        readonly parent: "python";
+    };
+    readonly copier: {
+        readonly type: "pip";
+        readonly parent: "python";
+    };
+    readonly corepack: {
+        readonly type: "npm";
+        readonly parent: "node";
+    };
+    readonly dart: {};
+    readonly deno: {};
+    readonly devbox: {};
+    readonly docker: {};
+    readonly 'docker-compose': {
+        readonly parent: "docker";
+    };
+    readonly dotnet: {};
+    readonly elixir: {
+        readonly parent: "erlang";
+    };
+    readonly erlang: {};
+    readonly flutter: {};
+    readonly flux: {};
+    readonly gh: {};
+    readonly ghc: {};
+    readonly git: {
+        readonly root: true;
+    };
+    readonly 'git-lfs': {
+        readonly parent: "git";
+    };
+    readonly gleam: {};
+    readonly golang: {};
+    readonly gradle: {
+        readonly parent: "java";
+    };
+    readonly hashin: {
+        readonly type: "pip";
+        readonly parent: "python";
+    };
+    readonly helm: {};
+    readonly helmfile: {};
+    readonly java: {};
+    readonly 'java-jdk': {};
+    readonly 'java-jre': {};
+    readonly jb: {};
+    readonly kas: {
+        readonly type: "pip";
+        readonly parent: "python";
+    };
+    readonly kubectl: {};
+    readonly kustomize: {};
+    readonly lerna: {
+        readonly type: "npm";
+        readonly parent: "node";
+        readonly deprecated: true;
+    };
+    readonly maven: {
+        readonly parent: "java";
+    };
+    readonly mise: {};
+    readonly mono: {};
+    readonly nix: {};
+    readonly node: {};
+    readonly npm: {
+        readonly type: "npm";
+        readonly parent: "node";
+    };
+    readonly nuget: {
+        readonly parent: "mono";
+    };
+    readonly paket: {
+        readonly parent: "dotnet";
+    };
+    readonly pdm: {
+        readonly type: "pip";
+        readonly parent: "python";
+    };
+    readonly php: {};
+    readonly 'pip-tools': {
+        readonly type: "pip";
+        readonly parent: "python";
+    };
+    readonly pipenv: {
+        readonly type: "pip";
+        readonly parent: "python";
+    };
+    readonly pixi: {};
+    readonly pnpm: {
+        readonly type: "npm";
+        readonly parent: "node";
+    };
+    readonly poetry: {
+        readonly type: "pip";
+        readonly parent: "python";
+    };
+    readonly powershell: {};
+    readonly protoc: {};
+    readonly python: {};
+    readonly renovate: {
+        readonly parent: "node";
+    };
+    readonly ruby: {};
+    readonly rust: {};
+    readonly sbt: {
+        readonly parent: "java";
+    };
+    readonly scala: {
+        readonly parent: "java";
+    };
+    readonly skopeo: {};
+    readonly sops: {};
+    readonly swift: {};
+    readonly terraform: {};
+    readonly tofu: {};
+    readonly uv: {
+        readonly type: "pip";
+        readonly parent: "python";
+    };
+    readonly vendir: {};
+    readonly wally: {};
+    readonly yarn: {
+        readonly parent: "node";
+    };
+    readonly 'yarn-slim': {
+        readonly parent: "node";
+    };
+};

package/dist/data.js

@@ -0,0 +1,82 @@
+/**
+ * All tools `install-tool` supports, sorted by name.
+ */
+export const tools = {
+    'android-sdk-cmdline-tools': { parent: 'java' },
+    apko: {},
+    apm: {},
+    bazelisk: {},
+    bower: { type: 'npm', parent: 'node', deprecated: true },
+    buf: {},
+    buildx: { parent: 'docker' },
+    bun: {},
+    bundler: { type: 'gem', parent: 'ruby' },
+    cabal: {},
+    checkov: { type: 'pip', parent: 'python' },
+    cocoapods: { parent: 'ruby' },
+    composer: { parent: 'php' },
+    conan: { parent: 'python' },
+    copier: { type: 'pip', parent: 'python' },
+    corepack: { type: 'npm', parent: 'node' },
+    dart: {},
+    deno: {},
+    devbox: {},
+    docker: {},
+    'docker-compose': { parent: 'docker' },
+    dotnet: {},
+    elixir: { parent: 'erlang' },
+    erlang: {},
+    flutter: {},
+    flux: {},
+    gh: {},
+    ghc: {},
+    git: { root: true },
+    'git-lfs': { parent: 'git' },
+    gleam: {},
+    golang: {},
+    gradle: { parent: 'java' },
+    hashin: { type: 'pip', parent: 'python' },
+    helm: {},
+    helmfile: {},
+    java: {},
+    'java-jdk': {},
+    'java-jre': {},
+    jb: {},
+    kas: { type: 'pip', parent: 'python' },
+    kubectl: {},
+    kustomize: {},
+    lerna: { type: 'npm', parent: 'node', deprecated: true },
+    maven: { parent: 'java' },
+    mise: {},
+    mono: {},
+    nix: {},
+    node: {},
+    npm: { type: 'npm', parent: 'node' },
+    nuget: { parent: 'mono' },
+    paket: { parent: 'dotnet' },
+    pdm: { type: 'pip', parent: 'python' },
+    php: {},
+    'pip-tools': { type: 'pip', parent: 'python' },
+    pipenv: { type: 'pip', parent: 'python' },
+    pixi: {},
+    pnpm: { type: 'npm', parent: 'node' },
+    poetry: { type: 'pip', parent: 'python' },
+    powershell: {},
+    protoc: {},
+    python: {},
+    renovate: { parent: 'node' },
+    ruby: {},
+    rust: {},
+    sbt: { parent: 'java' },
+    scala: { parent: 'java' },
+    skopeo: {},
+    sops: {},
+    swift: {},
+    terraform: {},
+    tofu: {},
+    uv: { type: 'pip', parent: 'python' },
+    vendir: {},
+    wally: {},
+    yarn: { parent: 'node' },
+    'yarn-slim': { parent: 'node' },
+};

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+import { tools } from './data.ts';
+export { tools } from './data.ts';
+export type { InstallToolType, ToolMetadata } from './types.ts';
+/**
+ * A tool name `install-tool` accepts.
+ */
+export type ToolName = keyof typeof tools;
+/**
+ * All supported tool names, sorted alphabetically.
+ */
+export declare const toolNames: ToolName[];

package/dist/index.js

@@ -0,0 +1,6 @@
+import { tools } from "./data.js";
+export { tools } from "./data.js";
+/**
+ * All supported tool names, sorted alphabetically.
+ */
+export const toolNames = Object.keys(tools);

package/dist/schema.d.ts

@@ -0,0 +1,40 @@
+import { z } from 'zod';
+export declare const InstallToolType: z.ZodEnum<{
+    gem: "gem";
+    npm: "npm";
+    pip: "pip";
+}>;
+/**
+ * Schema of a single entry of `tools.json`.
+ *
+ * Keep in sync with the `ToolMetadata` interface in `types.ts`, which is the
+ * zod free version used by the default export.
+ */
+export declare const ToolMetadata: z.ZodObject<{
+    type: z.ZodExactOptional<z.ZodEnum<{
+        gem: "gem";
+        npm: "npm";
+        pip: "pip";
+    }>>;
+    parent: z.ZodExactOptional<z.ZodString>;
+    deprecated: z.ZodExactOptional<z.ZodLiteral<true>>;
+    root: z.ZodExactOptional<z.ZodLiteral<true>>;
+}, z.core.$strict>;
+/**
+ * Schema of `tools.json`.
+ *
+ * The generated json schema lives in `data/tools.schema.json`.
+ */
+export declare const SupportedTools: z.ZodObject<{
+    tools: z.ZodRecord<z.ZodString, z.ZodObject<{
+        type: z.ZodExactOptional<z.ZodEnum<{
+            gem: "gem";
+            npm: "npm";
+            pip: "pip";
+        }>>;
+        parent: z.ZodExactOptional<z.ZodString>;
+        deprecated: z.ZodExactOptional<z.ZodLiteral<true>>;
+        root: z.ZodExactOptional<z.ZodLiteral<true>>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type SupportedTools = z.infer<typeof SupportedTools>;

package/dist/schema.js

@@ -0,0 +1,36 @@
+import { z } from 'zod';
+export const InstallToolType = z
+    .enum(['gem', 'npm', 'pip'])
+    .describe('the installer a dynamically installed tool is installed with');
+/**
+ * Schema of a single entry of `tools.json`.
+ *
+ * Keep in sync with the `ToolMetadata` interface in `types.ts`, which is the
+ * zod free version used by the default export.
+ */
+export const ToolMetadata = z.strictObject({
+    // exact optionals, so the inferred type matches the zod free interface
+    type: InstallToolType.describe('the installer used for this tool, only set for dynamically installed tools').exactOptional(),
+    parent: z
+        .string()
+        .describe('the tool this tool depends on, eg. composer depends on php')
+        .exactOptional(),
+    deprecated: z
+        .literal(true)
+        .describe('deprecated tools should not be used any more')
+        .exactOptional(),
+    root: z
+        .literal(true)
+        .describe('the tool can only be installed as root, so only at image build time')
+        .exactOptional(),
+});
+/**
+ * Schema of `tools.json`.
+ *
+ * The generated json schema lives in `data/tools.schema.json`.
+ */
+export const SupportedTools = z.strictObject({
+    tools: z
+        .record(z.string(), ToolMetadata)
+        .describe('all supported tools, keyed by tool name'),
+});

package/dist/types.d.ts

@@ -0,0 +1,25 @@
+/**
+ * The installer a dynamically installed tool is installed with.
+ */
+export type InstallToolType = 'gem' | 'npm' | 'pip';
+/**
+ * What containerbase knows about a supported tool.
+ */
+export interface ToolMetadata {
+    /**
+     * The installer used for this tool, only set for dynamically installed tools.
+     */
+    type?: InstallToolType;
+    /**
+     * The tool this tool depends on, eg. `composer` depends on `php`.
+     */
+    parent?: string;
+    /**
+     * Deprecated tools should not be used any more.
+     */
+    deprecated?: true;
+    /**
+     * The tool can only be installed as root, so only at image build time.
+     */
+    root?: true;
+}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/dist/zod.d.ts

@@ -0,0 +1,85 @@
+import { z } from 'zod';
+export * from './schema.ts';
+/**
+ * Enum of all tool names supported by the containerbase version this package
+ * was released with.
+ */
+export declare const ToolName: z.ZodEnum<{
+    npm: "npm";
+    "android-sdk-cmdline-tools": "android-sdk-cmdline-tools";
+    java: "java";
+    apko: "apko";
+    apm: "apm";
+    bazelisk: "bazelisk";
+    bower: "bower";
+    node: "node";
+    buf: "buf";
+    buildx: "buildx";
+    docker: "docker";
+    bun: "bun";
+    bundler: "bundler";
+    ruby: "ruby";
+    cabal: "cabal";
+    checkov: "checkov";
+    python: "python";
+    cocoapods: "cocoapods";
+    composer: "composer";
+    php: "php";
+    conan: "conan";
+    copier: "copier";
+    corepack: "corepack";
+    dart: "dart";
+    deno: "deno";
+    devbox: "devbox";
+    "docker-compose": "docker-compose";
+    dotnet: "dotnet";
+    elixir: "elixir";
+    erlang: "erlang";
+    flutter: "flutter";
+    flux: "flux";
+    gh: "gh";
+    ghc: "ghc";
+    git: "git";
+    "git-lfs": "git-lfs";
+    gleam: "gleam";
+    golang: "golang";
+    gradle: "gradle";
+    hashin: "hashin";
+    helm: "helm";
+    helmfile: "helmfile";
+    "java-jdk": "java-jdk";
+    "java-jre": "java-jre";
+    jb: "jb";
+    kas: "kas";
+    kubectl: "kubectl";
+    kustomize: "kustomize";
+    lerna: "lerna";
+    maven: "maven";
+    mise: "mise";
+    mono: "mono";
+    nix: "nix";
+    nuget: "nuget";
+    paket: "paket";
+    pdm: "pdm";
+    "pip-tools": "pip-tools";
+    pipenv: "pipenv";
+    pixi: "pixi";
+    pnpm: "pnpm";
+    poetry: "poetry";
+    powershell: "powershell";
+    protoc: "protoc";
+    renovate: "renovate";
+    rust: "rust";
+    sbt: "sbt";
+    scala: "scala";
+    skopeo: "skopeo";
+    sops: "sops";
+    swift: "swift";
+    terraform: "terraform";
+    tofu: "tofu";
+    uv: "uv";
+    vendir: "vendir";
+    wally: "wally";
+    yarn: "yarn";
+    "yarn-slim": "yarn-slim";
+}>;

package/dist/zod.js

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+import { toolNames } from "./index.js";
+export * from "./schema.js";
+/**
+ * Enum of all tool names supported by the containerbase version this package
+ * was released with.
+ */
+export const ToolName = z.enum(toolNames);

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@containerbase/base",
+  "version": "14.24.0",
+  "description": "Metadata about the tools supported by containerbase",
+  "keywords": [
+    "containerbase",
+    "tools"
+  ],
+  "homepage": "https://github.com/containerbase/base#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/containerbase/base.git",
+    "directory": "packages/base"
+  },
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./zod": {
+      "types": "./dist/zod.d.ts",
+      "default": "./dist/zod.js"
+    },
+    "./package.json": "./package.json",
+    "./tools.json": "./data/tools.json",
+    "./tools.schema.json": "./data/tools.schema.json"
+  },
+  "files": [
+    "data",
+    "dist"
+  ],
+  "devDependencies": {
+    "zod": "4.6.5"
+  },
+  "peerDependencies": {
+    "zod": "^4.0.0"
+  },
+  "peerDependenciesMeta": {
+    "zod": {
+      "optional": true
+    }
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  }
+}