Add oxa CLI package (#27)

* refactor(typescript): rename script to typecheck

* chore(*): move typecheck and rename to monorepo to avoid confusion

* feat(cli): initial iteration of `oxa` and `oxa-core`

* chore(oxa-core): silence warning

* ci(primary): typecheck `oxa-core` after codegen

* chore(oca core): formatting

* ci(primary): fix filter for oxa-types

* ci(primary): fix order

* ci(oxa types): build for oxa-core

* build(oxa): ensure schema.json is copied over

* docs(readme): separate out docs for oxa types

* refactor(oxa core): rename to `@oxa/core`

Author: nokome

.github/workflows/primary.yml

@@ -31,8 +31,8 @@ jobs:
 
       - run: pnpm install --frozen-lockfile
 
-      # Typecheck generation code in scripts/ (before format/lint possibly change line numbers)
-      - run: pnpm typecheck
+      # Typecheck codegen scripts (before format/lint possibly change line numbers)
+      - run: pnpm --filter scripts typecheck
 
       # On push: auto-fix formatting and linting (will be committed)
       - run: pnpm format
@@ -50,13 +50,22 @@ jobs:
         run: pnpm codegen all
 
       # Typecheck generated code (TypeScript via tsc, Python via ty, Rust via cargo)
-      - run: pnpm test
+      # Note: oxa-types-ts uses build (not typecheck) to produce dist/*.d.ts for @oxa/core
+      - run: pnpm build
         working-directory: packages/oxa-types-ts
       - run: uv run ty check src/
         working-directory: packages/oxa-types-py
       - run: cargo check
         working-directory: packages/oxa-types-rs
 
+      # Build and test @oxa/core
+      - run: pnpm --filter @oxa/core typecheck
+      - run: pnpm --filter @oxa/core build
+      - run: pnpm --filter @oxa/core test
+
+      # Build oxa (copy bundled CLI)
+      - run: pnpm --filter oxa build
+
       - name: Commit changes
         if: github.event_name == 'push'
         run: |

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "oxa",
+  "name": "oxa-monorepo",
   "version": "0.1.0",
   "private": true,
   "type": "module",
@@ -12,7 +12,6 @@
     "format:check": "prettier --check .",
     "lint": "eslint .",
     "lint:fix": "eslint --fix .",
-    "typecheck": "tsc -p scripts/tsconfig.json",
     "build": "pnpm -r build",
     "test": "pnpm -r test"
   },
@@ -22,6 +21,7 @@
     "prettier": "^3.7.4",
     "tsx": "^4.21.0",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.50.0"
+    "typescript-eslint": "^8.50.0",
+    "vitest": "^4.0.16"
   }
 }

packages/oxa-core/README.md

@@ -0,0 +1,76 @@
+# @oxa/core
+
+Validation library for OXA documents.
+
+## Installation
+
+```bash
+npm install @oxa/core
+```
+
+For CLI usage, see [`oxa`](https://www.npmjs.com/package/oxa).
+
+## Usage
+
+```typescript
+import { validate, validateFile, validateJson, validateYaml } from "@oxa/core";
+import type { Document } from "@oxa/core";
+
+// Validate a document object
+const doc: Document = {
+  type: "Document",
+  metadata: {},
+  title: [{ type: "Text", value: "Hello", classes: [], data: {} }],
+  children: [],
+};
+
+const result = validate(doc);
+if (result.valid) {
+  console.log("Document is valid!");
+} else {
+  console.error("Validation errors:", result.errors);
+}
+
+// Validate a file (JSON or YAML based on extension)
+const fileResult = validateFile("./document.json");
+
+// Validate JSON string
+const jsonResult = validateJson('{"type": "Document", ...}');
+
+// Validate YAML string
+const yamlResult = validateYaml("type: Document\n...");
+
+// Validate against a specific type
+const headingResult = validate(data, { type: "Heading" });
+```
+
+## API
+
+### `validate(data, options?)`
+
+Validate a parsed document object against the OXA schema.
+
+### `validateJson(json, options?)`
+
+Validate a JSON string against the OXA schema.
+
+### `validateYaml(yaml, options?)`
+
+Validate a YAML string against the OXA schema.
+
+### `validateFile(filePath, options?)`
+
+Validate a file (JSON or YAML based on extension).
+
+### `getSchema()`
+
+Get the bundled OXA JSON schema.
+
+### `getTypeNames()`
+
+Get available type names from the schema definitions.
+
+## Related Packages
+
+- [`oxa`](https://www.npmjs.com/package/oxa) - CLI for validating OXA documents
+- [`oxa-types`](https://www.npmjs.com/package/oxa-types) - TypeScript type definitions

packages/oxa-core/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@oxa/core",
+  "version": "0.1.0",
+  "description": "Validation library for OXA documents",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./schema.json": "./dist/schema.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc && cp ../../schema/schema.json dist/ && pnpm run build:bundle",
+    "build:bundle": "esbuild src/cli.ts --bundle --platform=node --target=node22 --format=cjs --outfile=dist/cli.bundle.cjs --banner:js='#!/usr/bin/env node' --log-override:empty-import-meta=silent",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "oxa-types": "workspace:*",
+    "ajv": "^8.17.1",
+    "ajv-formats": "^3.0.1",
+    "commander": "^14.0.0",
+    "js-yaml": "^4.1.0"
+  },
+  "devDependencies": {
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^22.0.0",
+    "esbuild": "^0.25.0",
+    "execa": "^9.5.0"
+  },
+  "keywords": [
+    "oxa",
+    "validate",
+    "schema",
+    "json",
+    "yaml"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/oxa-dev/oxa.git",
+    "directory": "packages/oxa-core"
+  },
+  "engines": {
+    "node": ">=22"
+  }
+}