jsonata-w 1.0.0 → 1.1.0

package/README.md

@@ -1,36 +1,41 @@
 # JSONata Workflow (jsonata-w)
 
-The **w** stands for **Workflow**. A command-line utility optimized to assist AI agents in transforming and inspecting JSON files, but equally powerful for manual workflows.
+The **w** stands for **Workflow**. A command-line utility optimized to assist AI agents in transforming and inspecting JSON/YAML files, but equally powerful for manual workflows.
 
 ## Commands
 
 ### Inspect
-Inspects the structure of a JSON file.
+Inspects the structure of a JSON or YAML file.
 
 ```bash
 jsonata-w inspect <file> [options]
 ```
 
 #### Options
-- `-s, --summary`: Show a high-level summary of the JSON structure (paths and keys).
+- `-s, --summary`: Show a high-level summary of the structure (paths and keys).
 - `--schema`: Generate and print the JSON schema for the scanned file.
 - `-d, --depth <number>`: Limit the depth of inspection (default: 1).
-- `--jsonpath <query>`: Filter the input JSON using a JSONPath expression before inspecting.
-- `--jsonata <expression>`: Filter the input JSON using a JSONata expression before inspecting.
+- `--jsonpath <query>`: Filter the input using a JSONPath expression before inspecting.
+- `--jsonata <expression>`: Filter the input using a JSONata expression before inspecting.
 
 #### Examples
-**Summary view:**
+**Summary view (JSON):**
 ```bash
 jsonata-w inspect data.json --summary
 ```
 
+**Summary view (YAML):**
+```bash
+jsonata-w inspect tokens.yml --summary
+```
+
 **Filter with JSONPath:**
 ```bash
 jsonata-w inspect data.json --jsonpath "$.users[*].name"
 ```
 
 ### Transform
-Transforms a JSON file using a JSONata expression file. The input and output paths are defined directly within the JSONata file using a standard configuration block.
+Transforms a JSON or YAML file using a JSONata expression file. The input and output paths are defined directly within the JSONata file using a standard configuration block.
 
 ```bash
 jsonata-w transform <file>
@@ -40,11 +45,14 @@ jsonata-w transform <file>
 The JSONata file MUST start with a configuration comment block:
 
 ```javascript
-/* @config {
-  "input": "./path/to/input.json",
-  "output": "./path/to/output.json",
-  "schema": "./optional/schema.json"
-} */
+/**
+ * @config {
+ *   "input": "./path/to/input.yml",
+ *   "output": "./path/to/output.json",
+ *   "schema": "./optional/schema.yml",
+ *   "examples": "./path/to/example.yml"
+ * }
+ */
 
 (
   /* Your JSONata expression here */
@@ -52,10 +60,15 @@ The JSONata file MUST start with a configuration comment block:
 )
 ```
 
-- `input`: Path to the source JSON file (relative to the .jsonata file).
-- `output`: Path where the transformed JSON will be saved (relative to the .jsonata file).
-- `schema`: (Optional) Path to a JSON schema for validation.
+- `input`: Path to the source file — supports `.json`, `.yml`, `.yaml` (relative to the .jsonata file).
+- `output`: Path where the result will be saved — format is auto-detected from extension:
+  - `.json` → JSON output
+  - `.yml` / `.yaml` → YAML output
+  - other → raw string output
+- `schema`: (Optional) Path to a JSON or YAML schema for validation.
+- `examples`: (Optional) Path to a JSON or YAML file containing the expected output subset for validation.
 
 #### Features
+- **YAML Support**: Full YAML support for input, output, schema, and example files. File format is detected from the extension (`.yml`/`.yaml` = YAML, everything else = JSON).
 - **Embedded Config**: No need for CLI arguments for input/output.
 - **Auto-Unflattening**: Results containing dot-notation keys (e.g., `{"a.b": 1}`) are automatically expanded into nested objects (`{"a": {"b": 1}}`). This simplifies generating deep hierarchies.

package/dist/cli.js

@@ -58,9 +58,9 @@ function pickSubset(data, template) {
     return result;
 }
 (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
-    .command('inspect <file>', 'Inspect JSON structure', (yargs) => {
+    .command('inspect <file>', 'Inspect JSON/YAML structure', (yargs) => {
     return yargs
-        .positional('file', { describe: 'JSON file to inspect', type: 'string', demandOption: true })
+        .positional('file', { describe: 'JSON/YAML file to inspect', type: 'string', demandOption: true })
         .option('depth', { alias: 'd', type: 'number', default: 1, describe: 'Depth to inspect' })
         .option('summary', { alias: 's', type: 'boolean', default: false, describe: 'Show structure summary' })
         .option('schema', { type: 'boolean', default: false, describe: 'Generate JSON schema from file' })
@@ -102,7 +102,7 @@ function pickSubset(data, template) {
         process.exit(1);
     }
 })
-    .command('transform <file>', 'Transform JSON using a single JSONata file with embedded @config', (yargs) => {
+    .command('transform <file>', 'Transform JSON/YAML using a single JSONata file with embedded @config', (yargs) => {
     return yargs
         .positional('file', { describe: 'JSONata file with embedded @config', type: 'string', demandOption: true });
 }, async (argv) => {
@@ -182,7 +182,13 @@ function pickSubset(data, template) {
         const dir = path_1.default.dirname(outputPath);
         if (!fs_1.default.existsSync(dir))
             fs_1.default.mkdirSync(dir, { recursive: true });
-        fs_1.default.writeFileSync(outputPath, JSON.stringify(finalResult, null, 2));
+        const isYamlOutput = outputPath.endsWith('.yml') || outputPath.endsWith('.yaml');
+        const outputContent = (typeof finalResult === 'string')
+            ? finalResult
+            : isYamlOutput
+                ? js_yaml_1.default.dump(finalResult, { indent: 2, lineWidth: -1 })
+                : JSON.stringify(finalResult, null, 2);
+        fs_1.default.writeFileSync(outputPath, outputContent);
         console.log(`Transformed ${config.input} -> ${config.output}`);
     }
     catch (e) {

package/dist/core/SchemaValidator.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SchemaValidator = void 0;
 const ajv_1 = __importDefault(require("ajv"));
 const fs_1 = __importDefault(require("fs"));
+const js_yaml_1 = __importDefault(require("js-yaml"));
 class SchemaValidator {
     constructor() {
         this.ajv = new ajv_1.default();
@@ -17,10 +18,12 @@ class SchemaValidator {
         const schemaContent = fs_1.default.readFileSync(schemaPath, 'utf-8');
         let schema;
         try {
-            schema = JSON.parse(schemaContent);
+            const isYaml = schemaPath.endsWith('.yml') || schemaPath.endsWith('.yaml');
+            schema = isYaml ? js_yaml_1.default.load(schemaContent) : JSON.parse(schemaContent);
         }
         catch (_e) {
-            throw new Error(`Invalid JSON schema in file: ${schemaPath}`);
+            const format = (schemaPath.endsWith('.yml') || schemaPath.endsWith('.yaml')) ? 'YAML' : 'JSON';
+            throw new Error(`Invalid ${format} schema in file: ${schemaPath}`);
         }
         const validate = this.ajv.compile(schema);
         const valid = validate(data);

package/dist/core/SourceLoader.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SourceLoader = void 0;
 const fs_1 = __importDefault(require("fs"));
+const js_yaml_1 = __importDefault(require("js-yaml"));
 class SourceLoader {
     constructor() {
         this.cache = new Map();
@@ -18,12 +19,14 @@ class SourceLoader {
         }
         const content = fs_1.default.readFileSync(path, 'utf-8');
         try {
-            const json = JSON.parse(content);
-            this.cache.set(path, json);
-            return json;
+            const isYaml = path.endsWith('.yml') || path.endsWith('.yaml');
+            const data = isYaml ? js_yaml_1.default.load(content) : JSON.parse(content);
+            this.cache.set(path, data);
+            return data;
         }
         catch (_e) {
-            throw new Error(`Invalid JSON in file: ${path}`);
+            const format = (path.endsWith('.yml') || path.endsWith('.yaml')) ? 'YAML' : 'JSON';
+            throw new Error(`Invalid ${format} in file: ${path}`);
         }
     }
     clearCache() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jsonata-w",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Tool to assist AI in transforming JSON files",
   "main": "dist/index.js",
   "bin": {
@@ -44,4 +44,4 @@
     "typescript": "^5.7.2",
     "typescript-eslint": "^8.51.0"
   }
-}
+}