@acid-cat/cli 0.0.0-stage → 0.2.0

package/dist/json/catalog.schema.json.js

@@ -0,0 +1,117 @@
+//#region ../../schemas/catalog.schema.json
+var catalog_schema_default = {
+	$schema: "https://json-schema.org/draft/2020-12/schema",
+	$id: "https://acid-cat.dev/schemas/0.1/catalog.schema.json",
+	title: "AcidCat catalog",
+	description: "One document that states what an application can do and which targets see it. See spec/catalog.md.",
+	type: "object",
+	required: [
+		"acidcat",
+		"targets",
+		"capabilities"
+	],
+	properties: {
+		"acidcat": {
+			"description": "The version of the AcidCat specification this catalog follows.",
+			"const": "0.1"
+		},
+		"title": { "type": "string" },
+		"description": { "type": "string" },
+		"targets": {
+			"description": "The targets, keyed by name.",
+			"type": "object",
+			"propertyNames": { "$ref": "#/$defs/targetName" },
+			"additionalProperties": { "$ref": "#/$defs/target" }
+		},
+		"$defs": {
+			"description": "Shared types, keyed by name. Capability schemas reference them as #/$defs/<Name>.",
+			"type": "object",
+			"propertyNames": { "$ref": "#/$defs/typeName" },
+			"additionalProperties": { "$ref": "#/$defs/schema" }
+		},
+		"capabilities": {
+			"description": "The capabilities, keyed by id.",
+			"type": "object",
+			"propertyNames": { "$ref": "#/$defs/id" },
+			"additionalProperties": { "$ref": "#/$defs/capability" }
+		}
+	},
+	$defs: {
+		"id": {
+			"type": "string",
+			"maxLength": 128,
+			"pattern": "^[a-z][a-z0-9]*(-[a-z0-9]+)*(\\.[a-z][a-z0-9]*(-[a-z0-9]+)*)+$"
+		},
+		"targetName": {
+			"type": "string",
+			"pattern": "^[a-z][a-z0-9-]*(:[a-z][a-z0-9-]*)?$"
+		},
+		"bindingName": {
+			"type": "string",
+			"pattern": "^[a-z][a-z0-9-]*(:[a-z][a-z0-9-]*)?$"
+		},
+		"typeName": {
+			"type": "string",
+			"pattern": "^[A-Za-z][A-Za-z0-9_]*$"
+		},
+		"target": {
+			"type": "object",
+			"required": ["bindings"],
+			"properties": {
+				"bindings": {
+					"type": "array",
+					"items": { "$ref": "#/$defs/bindingName" },
+					"minItems": 1,
+					"uniqueItems": true
+				},
+				"description": { "type": "string" },
+				"options": { "type": "object" }
+			}
+		},
+		"schema": {
+			"description": "A JSON Schema 2020-12 schema. Its $refs point into the catalog's $defs.",
+			"type": ["object", "boolean"]
+		},
+		"objectSchema": {
+			"description": "An input schema: it states that the input is an object, or it references a type.",
+			"type": "object",
+			"anyOf": [{
+				"required": ["type"],
+				"properties": { "type": { "const": "object" } }
+			}, {
+				"required": ["$ref"],
+				"properties": { "$ref": { "type": "string" } }
+			}]
+		},
+		"capability": {
+			"type": "object",
+			"required": ["description"],
+			"properties": {
+				"description": {
+					"type": "string",
+					"minLength": 1,
+					"pattern": "\\S"
+				},
+				"audience": {
+					"type": "array",
+					"items": { "$ref": "#/$defs/targetName" },
+					"uniqueItems": true
+				},
+				"input": { "$ref": "#/$defs/objectSchema" },
+				"output": { "$ref": "#/$defs/schema" },
+				"failures": {
+					"type": "object",
+					"propertyNames": {
+						"type": "string",
+						"minLength": 1
+					},
+					"additionalProperties": { "$ref": "#/$defs/schema" }
+				},
+				"readOnly": { "type": "boolean" },
+				"state": { "$ref": "#/$defs/schema" }
+			}
+		}
+	}
+};
+//#endregion
+export { catalog_schema_default as default };

package/dist/json/fixture.acidcat.json.js

@@ -0,0 +1,105 @@
+//#region conformance/fixture.acidcat.json
+var fixture_acidcat_default = {
+	acidcat: "0.1",
+	title: "AcidCat conformance fixture",
+	targets: {
+		"api": { "bindings": ["http"] },
+		"app": { "bindings": ["typescript", "webmcp"] },
+		"cli": { "bindings": ["cli"] },
+		"mcp": { "bindings": ["mcp"] }
+	},
+	capabilities: {
+		"fixture.crash": {
+			"description": "Always fail with a defect.",
+			"audience": [
+				"app",
+				"mcp",
+				"cli",
+				"api"
+			]
+		},
+		"fixture.echo": {
+			"description": "Return the input text.",
+			"audience": [
+				"app",
+				"mcp",
+				"cli",
+				"api"
+			],
+			"input": {
+				"properties": { "text": { "type": "string" } },
+				"required": ["text"],
+				"type": "object"
+			},
+			"output": {
+				"properties": { "text": { "type": "string" } },
+				"required": ["text"],
+				"type": "object"
+			},
+			"readOnly": true
+		},
+		"fixture.hidden": {
+			"description": "Only the app target can use this capability.",
+			"audience": ["app"]
+		},
+		"fixture.refuse": {
+			"description": "Always return the failure Refused.",
+			"audience": [
+				"app",
+				"mcp",
+				"cli",
+				"api"
+			],
+			"failures": { "Refused": {
+				"properties": {
+					"_tag": {
+						"const": "Refused",
+						"type": "string"
+					},
+					"reason": { "type": "string" }
+				},
+				"required": ["_tag", "reason"],
+				"type": "object"
+			} }
+		},
+		"fixture.slow": {
+			"description": "Wait for some milliseconds, then return null.",
+			"audience": [
+				"app",
+				"mcp",
+				"cli",
+				"api"
+			],
+			"input": {
+				"properties": { "milliseconds": { "type": "number" } },
+				"required": ["milliseconds"],
+				"type": "object"
+			}
+		},
+		"fixture.switch.set": {
+			"description": "Turn the switch on or off. The switch controls the availability of fixture.toggle.",
+			"audience": [
+				"app",
+				"mcp",
+				"cli",
+				"api"
+			],
+			"input": {
+				"properties": { "on": { "type": "boolean" } },
+				"required": ["on"],
+				"type": "object"
+			}
+		},
+		"fixture.toggle": {
+			"description": "Available only while the switch is on.",
+			"audience": [
+				"app",
+				"mcp",
+				"cli",
+				"api"
+			]
+		}
+	}
+};
+//#endregion
+export { fixture_acidcat_default as default };

package/dist/json/package.json.js

@@ -0,0 +1,4 @@
+//#region package.json
+var version = "0.2.0";
+//#endregion
+export { version };

package/dist/main.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/main.js

@@ -0,0 +1,98 @@
+#!/usr/bin/env node
+import { check, viewOf } from "./catalog.js";
+import { conform } from "./conform/index.js";
+import { version } from "./json/package.json.js";
+import { canonicalText } from "@acid-cat/catalog";
+import { Console, Effect, FileSystem, Option } from "effect";
+import { NodeRuntime, NodeServices } from "@effect/platform-node";
+import { Argument, Command, Flag } from "effect/cli";
+//#region src/main.ts
+/**
+* `acid-cat`: check, format and view AcidCat catalogs.
+*
+* Exit codes: 0 when the command succeeds, 1 when a catalog does not conform or a file is not found.
+*/
+const readCatalog = Effect.fn("readCatalog")(function* (file) {
+	const text = yield* (yield* FileSystem.FileSystem).readFileString(file);
+	return {
+		text,
+		document: JSON.parse(text)
+	};
+});
+const fail = Effect.sync(() => {
+	process.exitCode = 1;
+});
+const files = Argument.String("catalog").pipe(Argument.withDescription("A catalog file, such as acidcat.catalog.json"), Argument.variadic({ min: 1 }));
+const checkCommand = Command.make("check", {
+	files,
+	strict: Flag.Boolean("strict").pipe(Flag.withDescription("Fail on warnings too"), Flag.withDefault(false))
+}, Effect.fn(function* ({ files, strict }) {
+	let failed = false;
+	for (const file of files) {
+		const { text, document } = yield* readCatalog(file);
+		const report = check(document, text);
+		for (const error of report.errors) yield* Console.error(`${file}: error: ${error}`);
+		for (const warning of report.warnings) yield* Console.error(`${file}: warning: ${warning}`);
+		failed ||= report.errors.length > 0 || strict && report.warnings.length > 0;
+	}
+	if (failed) return yield* fail;
+	yield* Console.log(files.length === 1 ? "The catalog conforms." : "Every catalog conforms.");
+})).pipe(Command.withDescription("Check that catalogs conform to the specification."));
+const formatCommand = Command.make("format", {
+	files,
+	write: Flag.Boolean("write").pipe(Flag.withDescription("Rewrite each file instead of printing it"), Flag.withDefault(false))
+}, Effect.fn(function* ({ files, write }) {
+	const fs = yield* FileSystem.FileSystem;
+	for (const file of files) {
+		const { document } = yield* readCatalog(file);
+		const text = canonicalText(document);
+		if (write) yield* fs.writeFileString(file, text);
+		else yield* Effect.sync(() => process.stdout.write(text));
+	}
+})).pipe(Command.withDescription("Write catalogs in canonical form."));
+const viewCommand = Command.make("view", {
+	file: Argument.String("catalog").pipe(Argument.withDescription("A catalog file")),
+	target: Argument.String("target").pipe(Argument.withDescription("The name of a target in the catalog"))
+}, Effect.fn(function* ({ file, target }) {
+	const { document } = yield* readCatalog(file);
+	const catalog = document;
+	if (!(target in catalog.targets)) {
+		yield* Console.error(`${file}: error: there is no target ${target}`);
+		return yield* fail;
+	}
+	yield* Effect.sync(() => process.stdout.write(canonicalText(viewOf(catalog, target))));
+})).pipe(Command.withDescription("Print the view of one target."));
+const url = (name, description) => Flag.String(name).pipe(Flag.withDescription(description), Flag.optional);
+const conformCommand = Command.make("conform", {
+	mcp: url("mcp", "The URL of the MCP server"),
+	http: url("http", "The base URL of the HTTP API, before /capabilities"),
+	cli: url("cli", "The command that starts the command line, for example \"node fixture-cli.ts\""),
+	webmcp: url("webmcp", "The URL of a web page that serves the app target. It runs in Chromium, through Playwright"),
+	maximumBytes: Flag.Int("max-bytes").pipe(Flag.withDescription("The body limit of the remote bindings"), Flag.withDefault(1048576))
+}, Effect.fn(function* (options) {
+	const value = (option) => Option.isSome(option) ? option.value : void 0;
+	const command = value(options.cli)?.split(/\s+/).filter((word) => word !== "");
+	const results = yield* Effect.promise(() => conform({
+		mcp: value(options.mcp),
+		http: value(options.http),
+		cli: command,
+		webmcp: value(options.webmcp),
+		maximumBytes: options.maximumBytes
+	}));
+	if (results.length === 0) {
+		yield* Console.error("Give at least one binding: --mcp, --http, --cli or --webmcp.");
+		return yield* fail;
+	}
+	for (const result of results) yield* Console.log(`${result.passed ? "✓" : "✗"} ${result.binding}: ${result.name} (${result.rule})${result.detail ? `\n    ${result.detail}` : ""}`);
+	const failed = results.filter((result) => !result.passed).length;
+	yield* Console.log(`\n${results.length - failed} passed, ${failed} failed.`);
+	if (failed > 0) return yield* fail;
+})).pipe(Command.withDescription("Test a running implementation of the conformance fixture through its bindings."));
+Command.make("acid-cat").pipe(Command.withDescription("Check, format and view AcidCat catalogs, and test implementations."), Command.withSubcommands([
+	checkCommand,
+	formatCommand,
+	viewCommand,
+	conformCommand
+])).pipe(Command.run({ version }), Effect.provide(NodeServices.layer), NodeRuntime.runMain);
+//#endregion
+export {};

package/package.json

@@ -1,6 +1,61 @@
 {
   "name": "@acid-cat/cli",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.2.0",
+  "description": "The AcidCat command line: check, format and view catalogs, and test implementations.",
+  "keywords": [
+    "acidcat",
+    "cli",
+    "conformance"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Hebilicious/acidcat.git",
+    "directory": "packages/cli"
+  },
+  "homepage": "https://github.com/Hebilicious/acidcat/tree/main/packages/cli#readme",
+  "bugs": "https://github.com/Hebilicious/acidcat/issues",
+  "type": "module",
+  "engines": {
+    "node": ">=24"
+  },
+  "files": [
+    "dist",
+    "conformance/fixture.acidcat.json"
+  ],
+  "bin": {
+    "acid-cat": "./dist/main.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./conformance/fixture.acidcat.json": "./conformance/fixture.acidcat.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@acid-cat/catalog": "0.2.0",
+    "@acid-cat/spec-ts": "0.2.0",
+    "@effect/platform-node": "4.0.4",
+    "@effect/platform-node-shared": "4.0.4",
+    "@modelcontextprotocol/client": "2.3.1",
+    "effect": "4.0.4",
+    "fast-check": "4.10.2"
+  },
+  "peerDependencies": {
+    "playwright": "^1.64.0"
+  },
+  "peerDependenciesMeta": {
+    "playwright": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/node": "26.6.5",
+    "playwright": "1.64.0",
+    "typescript": "7.0.2"
+  }
 }