arri 0.81.1 → 0.81.2

package/README.md

@@ -12,15 +12,16 @@ Command line interface for ARRI-RPC
 
 Run `arri --help` to get a full list of commands
 
-| Cmd                  | Description                                                                                                                                         |
-| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
-| build                | Use the currently registered server plugin to build your arri server and run the code generators                                                    |
-| dev                  | Run the currently registered server plugin in dev mode (basically watches for changes and rebuilds the server and reruns code generators as needed) |
-| codegen [input-file] | Run generate clients specified in the `arri.config.ts`. See [here](#running-arri-codegen) for details.                                              |
-| init [dir]           | Scaffold an arri app/library                                                                                                                        |
-| list                 | List available arri versions                                                                                                                        |
-| use [version]        | Update arri dependencies to a specific version (checks recursively for package.json, pubspec.yaml, cargo.toml, etc)                                 |
-| version              | Print current CLI version                                                                                                                           |
+| Cmd                          | Description                                                                                                                                         |
+| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| build                        | Use the currently registered server plugin to build your arri server and run the code generators                                                    |
+| dev                          | Run the currently registered server plugin in dev mode (basically watches for changes and rebuilds the server and reruns code generators as needed) |
+| codegen [input-file]         | Run generate clients specified in the `arri.config.ts`. See [here](#running-arri-codegen) for details.                                              |
+| export [format] [input-file] | Export AppDefinition to various formats. See [here](#exporting-json-schema) for details.                                                            |
+| init [dir]                   | Scaffold an arri app/library                                                                                                                        |
+| list                         | List available arri versions                                                                                                                        |
+| use [version]                | Update arri dependencies to a specific version (checks recursively for package.json, pubspec.yaml, cargo.toml, etc)                                 |
+| version                      | Print current CLI version                                                                                                                           |
 
 ## Usage with an Arri server
 
@@ -109,3 +110,41 @@ arri codegen https://example.com/__definition
 | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------- |
 | --config | -c      | Path to an arri config. Default is `arri.config.ts`                                                                       |
 | --watch  | -w      | Watch an app definition file for changes. Only works on files. It will throw an error if invoked against an HTTP endpoint |
+
+## Exporting JSON Schema
+
+`arri export json-schema` allows you to export your AppDefinition types as a [JSON Schema](https://json-schema.org/) file. This is useful for:
+
+- **Editor support** - YAML/JSON files using Arri-defined schemas can get autocomplete in VS Code, IntelliJ, etc.
+- **Interoperability** - Integration with tools that consume JSON Schema (OpenAPI, documentation generators, etc.)
+- **Configuration validation** - Users defining config files can reference a JSON Schema URL for validation
+
+### Basic Usage
+
+```bash
+# Export from a local file
+arri export json-schema ./path/to/AppDefinition.json
+
+# Export from a TS/JS file
+arri export json-schema ./path/to/definitions.ts
+
+# Export from an HTTP endpoint
+arri export json-schema https://example.com/__definition
+```
+
+### Export Flags
+
+| Flag          | Aliases | Description                                                  |
+| ------------- | ------- | ------------------------------------------------------------ |
+| --output      | -o      | Output file path for JSON Schema. Default is `./schema.json` |
+| --id          |         | `$id` to use in the JSON Schema                              |
+| --title       |         | Title for the JSON Schema                                    |
+| --description |         | Description for the JSON Schema                              |
+
+### Example
+
+```bash
+arri export json-schema ./AppDefinition.json -o ./schemas/api.schema.json --id "https://example.com/schemas/api.json" --title "My API Schema" --description "API type definitions"
+```
+
+This will generate a JSON Schema file with all your type definitions in the `$defs` section, which can then be used for validation and editor support.

package/dist/cli.cjs

@@ -3,11 +3,10 @@
 
 const citty = require('citty');
 const c12 = require('c12');
-const common = require('./shared/arri.pHQOQ5Wb.cjs');
+const common = require('./shared/arri.CjdtGagO.cjs');
 const fs = require('node:fs');
 const codegenUtils = require('@arrirpc/codegen-utils');
 const chokidar = require('chokidar');
-const ofetch = require('ofetch');
 const path = require('pathe');
 const schema = require('@arrirpc/schema');
 const Degit = require('degit');
@@ -15,6 +14,7 @@ const enquirer = require('enquirer');
 const prettier = require('prettier');
 const consola = require('consola');
 const promises = require('fs/promises');
+const ofetch = require('ofetch');
 const node_url = require('node:url');
 
 var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
@@ -114,23 +114,17 @@ const codegen = citty.defineCommand({
       process.exit(1);
     }
     const isUrl = args.schema.startsWith("http://") || args.schema.startsWith("https://");
+    if (isUrl && args.watch) {
+      throw new Error("Cannot watch a URL");
+    }
     let def;
-    if (isUrl) {
-      if (args.watch) throw new Error("Cannot watch a URL");
-      const result = await ofetch.ofetch(args.schema);
-      if (!codegenUtils.isAppDefinition(result)) {
-        throw new Error(`Invalid App Definition at ${args.schema}`);
-      }
-      def = result;
-    } else {
-      try {
-        def = await getAppDefinitionFromFile(args.schema);
-      } catch (err) {
-        if (!args.watch) {
-          throw err;
-        }
-        common.logger.error(err);
+    try {
+      def = await common.loadAppDefinition(args.schema);
+    } catch (err) {
+      if (!args.watch) {
+        throw err;
       }
+      common.logger.error(err);
     }
     if (!def && !args.watch) {
       throw new Error(`Unable to find App Definition at ${args.schema}`);
@@ -150,7 +144,7 @@ const codegen = citty.defineCommand({
         common.logger.info(`Change detected`);
         const startTime = /* @__PURE__ */ new Date();
         await runGenerators(
-          await getAppDefinitionFromFile(args.schema),
+          await common.loadAppDefinition(args.schema),
           config.generators ?? []
         );
         common.logger.success(
@@ -165,7 +159,7 @@ const codegen = citty.defineCommand({
         common.logger.info(`Change detected in AppDefinition file.`);
         const startTime = /* @__PURE__ */ new Date();
         await runGenerators(
-          await getAppDefinitionFromFile(args.schema),
+          await common.loadAppDefinition(args.schema),
           config.generators ?? []
         );
         common.logger.success(
@@ -177,37 +171,13 @@ const codegen = citty.defineCommand({
     });
   }
 });
-async function getAppDefinitionFromFile(file) {
-  if (!fs__default.existsSync(file)) {
-    throw new Error(`Unable to find ${file}`);
-  }
-  const isTs = file.endsWith(".ts");
-  const isJs = file.endsWith(".js");
-  if (isTs || isJs) {
-    const schemaResult = await c12.loadConfig({
-      configFile: file
-    });
-    if (!codegenUtils.isAppDefinition(schemaResult.config)) {
-      throw new Error(`Invalid App Definition at ${file}`);
-    }
-    return schemaResult.config;
-  } else {
-    const parsingResult = JSON.parse(
-      fs__default.readFileSync(file, { encoding: "utf-8" })
-    );
-    if (!codegenUtils.isAppDefinition(parsingResult)) {
-      throw new Error(`Invalid App Definition at ${file}`);
-    }
-    return parsingResult;
-  }
-}
 async function runGenerators(def, generators) {
   common.logger.info(`Generating ${generators?.length} client(s)`);
   await Promise.allSettled(
     generators.map(
       (gen) => gen.run(
         def ?? {
-          schemaVersion: "0.0.7",
+          schemaVersion: codegenUtils.SCHEMA_VERSION,
           procedures: {},
           definitions: {}
         }
@@ -216,6 +186,72 @@ async function runGenerators(def, generators) {
   );
 }
 
+const jsonSchema = citty.defineCommand({
+  meta: {
+    name: "json-schema",
+    description: "Export AppDefinition types as JSON Schema"
+  },
+  args: {
+    input: {
+      type: "positional",
+      required: true,
+      description: "Path to AppDefinition file (JSON, JS, or TS) or HTTP URL"
+    },
+    output: {
+      type: "string",
+      alias: ["o"],
+      description: "Output file path for JSON Schema",
+      default: "./schema.json"
+    },
+    id: { type: "string", description: "$id to use in the JSON Schema" },
+    title: { type: "string", description: "Title for the JSON Schema" },
+    description: {
+      type: "string",
+      description: "Description for the JSON Schema"
+    }
+  },
+  async run({ args }) {
+    common.logger.info(`Loading AppDefinition from ${args.input}...`);
+    const def = await common.loadAppDefinition(args.input);
+    const jsonSchema = appDefinitionToJsonSchema(def, {
+      $id: args.id,
+      title: args.title,
+      description: args.description
+    });
+    const outputPath = path__default.resolve(args.output);
+    fs__default.mkdirSync(path__default.dirname(outputPath), { recursive: true });
+    fs__default.writeFileSync(outputPath, JSON.stringify(jsonSchema, null, 2));
+    common.logger.success(`JSON Schema exported to ${outputPath}`);
+  }
+});
+function appDefinitionToJsonSchema(def, options) {
+  const $defs = Object.fromEntries(
+    Object.entries(def.definitions ?? {}).map(([name, schema$1]) => [
+      name,
+      schema.schemaToJsonSchema(schema$1)
+    ])
+  );
+  const description = options?.description ?? def.info?.description;
+  const title = options?.title ?? def.info?.title;
+  return {
+    $schema: "https://json-schema.org/draft/2020-12/schema",
+    ...options?.$id && { $id: options.$id },
+    ...title && { title },
+    ...description && { description },
+    ...Object.keys($defs).length > 0 && { $defs }
+  };
+}
+
+const exportCmd = citty.defineCommand({
+  meta: {
+    name: "export",
+    description: "Export AppDefinition to various formats"
+  },
+  subCommands: {
+    "json-schema": jsonSchema
+  }
+});
+
 const Language = schema.a.enumerator(["typescript", "go"]);
 const CliArgs = schema.a.object({
   dir: schema.a.string(),
@@ -820,6 +856,7 @@ const main = citty.defineCommand({
     build,
     codegen,
     dev: common.dev,
+    export: exportCmd,
     init,
     list,
     use,

package/dist/cli.mjs

@@ -1,18 +1,18 @@
 #! /usr/bin/env node
 import { defineCommand, runCommand, runMain } from 'citty';
 import { loadConfig } from 'c12';
-import { a as isArriConfig, l as logger, g as getArriPackageMetadata, e as dev } from './shared/arri.CGlJ9Ywd.mjs';
+import { a as isArriConfig, l as logger, e as loadAppDefinition, g as getArriPackageMetadata, f as dev } from './shared/arri.Bq5F3a0A.mjs';
 import fs, { rmSync, readFileSync, writeFileSync } from 'node:fs';
-import { isAppDefinition, kebabCase } from '@arrirpc/codegen-utils';
+import { SCHEMA_VERSION, kebabCase } from '@arrirpc/codegen-utils';
 import { watch } from 'chokidar';
-import { ofetch } from 'ofetch';
 import path from 'pathe';
-import { a } from '@arrirpc/schema';
+import { schemaToJsonSchema, a } from '@arrirpc/schema';
 import Degit from 'degit';
 import enquirer from 'enquirer';
 import prettier from 'prettier';
 import consola from 'consola';
 import { readFile, writeFile } from 'fs/promises';
+import { ofetch } from 'ofetch';
 import { fileURLToPath } from 'node:url';
 
 const build = defineCommand({
@@ -102,23 +102,17 @@ const codegen = defineCommand({
       process.exit(1);
     }
     const isUrl = args.schema.startsWith("http://") || args.schema.startsWith("https://");
+    if (isUrl && args.watch) {
+      throw new Error("Cannot watch a URL");
+    }
     let def;
-    if (isUrl) {
-      if (args.watch) throw new Error("Cannot watch a URL");
-      const result = await ofetch(args.schema);
-      if (!isAppDefinition(result)) {
-        throw new Error(`Invalid App Definition at ${args.schema}`);
-      }
-      def = result;
-    } else {
-      try {
-        def = await getAppDefinitionFromFile(args.schema);
-      } catch (err) {
-        if (!args.watch) {
-          throw err;
-        }
-        logger.error(err);
+    try {
+      def = await loadAppDefinition(args.schema);
+    } catch (err) {
+      if (!args.watch) {
+        throw err;
       }
+      logger.error(err);
     }
     if (!def && !args.watch) {
       throw new Error(`Unable to find App Definition at ${args.schema}`);
@@ -138,7 +132,7 @@ const codegen = defineCommand({
         logger.info(`Change detected`);
         const startTime = /* @__PURE__ */ new Date();
         await runGenerators(
-          await getAppDefinitionFromFile(args.schema),
+          await loadAppDefinition(args.schema),
           config.generators ?? []
         );
         logger.success(
@@ -153,7 +147,7 @@ const codegen = defineCommand({
         logger.info(`Change detected in AppDefinition file.`);
         const startTime = /* @__PURE__ */ new Date();
         await runGenerators(
-          await getAppDefinitionFromFile(args.schema),
+          await loadAppDefinition(args.schema),
           config.generators ?? []
         );
         logger.success(
@@ -165,37 +159,13 @@ const codegen = defineCommand({
     });
   }
 });
-async function getAppDefinitionFromFile(file) {
-  if (!fs.existsSync(file)) {
-    throw new Error(`Unable to find ${file}`);
-  }
-  const isTs = file.endsWith(".ts");
-  const isJs = file.endsWith(".js");
-  if (isTs || isJs) {
-    const schemaResult = await loadConfig({
-      configFile: file
-    });
-    if (!isAppDefinition(schemaResult.config)) {
-      throw new Error(`Invalid App Definition at ${file}`);
-    }
-    return schemaResult.config;
-  } else {
-    const parsingResult = JSON.parse(
-      fs.readFileSync(file, { encoding: "utf-8" })
-    );
-    if (!isAppDefinition(parsingResult)) {
-      throw new Error(`Invalid App Definition at ${file}`);
-    }
-    return parsingResult;
-  }
-}
 async function runGenerators(def, generators) {
   logger.info(`Generating ${generators?.length} client(s)`);
   await Promise.allSettled(
     generators.map(
       (gen) => gen.run(
         def ?? {
-          schemaVersion: "0.0.7",
+          schemaVersion: SCHEMA_VERSION,
           procedures: {},
           definitions: {}
         }
@@ -204,6 +174,72 @@ async function runGenerators(def, generators) {
   );
 }
 
+const jsonSchema = defineCommand({
+  meta: {
+    name: "json-schema",
+    description: "Export AppDefinition types as JSON Schema"
+  },
+  args: {
+    input: {
+      type: "positional",
+      required: true,
+      description: "Path to AppDefinition file (JSON, JS, or TS) or HTTP URL"
+    },
+    output: {
+      type: "string",
+      alias: ["o"],
+      description: "Output file path for JSON Schema",
+      default: "./schema.json"
+    },
+    id: { type: "string", description: "$id to use in the JSON Schema" },
+    title: { type: "string", description: "Title for the JSON Schema" },
+    description: {
+      type: "string",
+      description: "Description for the JSON Schema"
+    }
+  },
+  async run({ args }) {
+    logger.info(`Loading AppDefinition from ${args.input}...`);
+    const def = await loadAppDefinition(args.input);
+    const jsonSchema = appDefinitionToJsonSchema(def, {
+      $id: args.id,
+      title: args.title,
+      description: args.description
+    });
+    const outputPath = path.resolve(args.output);
+    fs.mkdirSync(path.dirname(outputPath), { recursive: true });
+    fs.writeFileSync(outputPath, JSON.stringify(jsonSchema, null, 2));
+    logger.success(`JSON Schema exported to ${outputPath}`);
+  }
+});
+function appDefinitionToJsonSchema(def, options) {
+  const $defs = Object.fromEntries(
+    Object.entries(def.definitions ?? {}).map(([name, schema]) => [
+      name,
+      schemaToJsonSchema(schema)
+    ])
+  );
+  const description = options?.description ?? def.info?.description;
+  const title = options?.title ?? def.info?.title;
+  return {
+    $schema: "https://json-schema.org/draft/2020-12/schema",
+    ...options?.$id && { $id: options.$id },
+    ...title && { title },
+    ...description && { description },
+    ...Object.keys($defs).length > 0 && { $defs }
+  };
+}
+
+const exportCmd = defineCommand({
+  meta: {
+    name: "export",
+    description: "Export AppDefinition to various formats"
+  },
+  subCommands: {
+    "json-schema": jsonSchema
+  }
+});
+
 const Language = a.enumerator(["typescript", "go"]);
 const CliArgs = a.object({
   dir: a.string(),
@@ -808,6 +844,7 @@ const main = defineCommand({
     build,
     codegen,
     dev,
+    export: exportCmd,
     init,
     list,
     use,

package/dist/index.cjs

@@ -5,7 +5,7 @@ const kotlinCodegen = require('@arrirpc/codegen-kotlin');
 const rustCodegen = require('@arrirpc/codegen-rust');
 const swiftCodegen = require('@arrirpc/codegen-swift');
 const typescriptCodegen = require('@arrirpc/codegen-ts');
-const common = require('./shared/arri.pHQOQ5Wb.cjs');
+const common = require('./shared/arri.CjdtGagO.cjs');
 const node_child_process = require('node:child_process');
 const fs = require('node:fs');
 const node_process = require('node:process');

package/dist/index.mjs

@@ -3,8 +3,8 @@ import * as kotlinCodegen from '@arrirpc/codegen-kotlin';
 import * as rustCodegen from '@arrirpc/codegen-rust';
 import * as swiftCodegen from '@arrirpc/codegen-swift';
 import * as typescriptCodegen from '@arrirpc/codegen-ts';
-import { d as defineServerConfig, l as logger, i as isInsideDir } from './shared/arri.CGlJ9Ywd.mjs';
-export { D as DEV_DEFINITION_ENDPOINT, b as defineConfig, a as isArriConfig, c as isServerConfig } from './shared/arri.CGlJ9Ywd.mjs';
+import { d as defineServerConfig, l as logger, i as isInsideDir } from './shared/arri.Bq5F3a0A.mjs';
+export { D as DEV_DEFINITION_ENDPOINT, b as defineConfig, a as isArriConfig, c as isServerConfig } from './shared/arri.Bq5F3a0A.mjs';
 import { execSync, spawn } from 'node:child_process';
 import fs$1, { existsSync } from 'node:fs';
 import { cwd } from 'node:process';

package/dist/shared/{arri.CGlJ9Ywd.mjs → arri.Bq5F3a0A.mjs}

@@ -1,6 +1,8 @@
 import { loadConfig } from 'c12';
 import { defineCommand, runCommand } from 'citty';
 import path from 'pathe';
+import fs from 'node:fs';
+import { isAppDefinition } from '@arrirpc/codegen-utils';
 import { a, ValidationException } from '@arrirpc/schema';
 import { createConsola } from 'consola';
 import { ofetch } from 'ofetch';
@@ -71,6 +73,31 @@ const dev = defineCommand({
 });
 
 const logger = createConsola().withTag("arri");
+async function loadAppDefinition(input) {
+  const isUrl = input.startsWith("http://") || input.startsWith("https://");
+  if (isUrl) {
+    const result = await ofetch(input);
+    if (!isAppDefinition(result)) {
+      throw new Error(`Invalid App Definition at ${input}`);
+    }
+    return result;
+  }
+  if (!fs.existsSync(input)) {
+    throw new Error(`Unable to find ${input}`);
+  }
+  if (input.endsWith(".ts") || input.endsWith(".js")) {
+    const { config } = await loadConfig({ configFile: input });
+    if (!isAppDefinition(config)) {
+      throw new Error(`Invalid App Definition at ${input}`);
+    }
+    return config;
+  }
+  const parsed = JSON.parse(fs.readFileSync(input, "utf-8"));
+  if (!isAppDefinition(parsed)) {
+    throw new Error(`Invalid App Definition at ${input}`);
+  }
+  return parsed;
+}
 function isInsideDir(dir, parentDir) {
   if (path.resolve(dir).startsWith(path.resolve(parentDir))) {
     return true;
@@ -159,4 +186,4 @@ const NpmRegistryPackage = a.object({
   readmeFilename: a.optional(a.string())
 });
 
-export { DEV_DEFINITION_ENDPOINT as D, isArriConfig as a, defineConfig as b, isServerConfig as c, defineServerConfig as d, dev as e, getArriPackageMetadata as g, isInsideDir as i, logger as l };
+export { DEV_DEFINITION_ENDPOINT as D, isArriConfig as a, defineConfig as b, isServerConfig as c, defineServerConfig as d, loadAppDefinition as e, dev as f, getArriPackageMetadata as g, isInsideDir as i, logger as l };

package/dist/shared/{arri.pHQOQ5Wb.cjs → arri.CjdtGagO.cjs}

@@ -3,6 +3,8 @@
 const c12 = require('c12');
 const citty = require('citty');
 const path = require('pathe');
+const fs = require('node:fs');
+const codegenUtils = require('@arrirpc/codegen-utils');
 const schema = require('@arrirpc/schema');
 const consola = require('consola');
 const ofetch = require('ofetch');
@@ -10,6 +12,7 @@ const ofetch = require('ofetch');
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
 
 const path__default = /*#__PURE__*/_interopDefaultCompat(path);
+const fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
 
 function isServerConfig(input) {
   if (typeof input !== "object" || input === null) {
@@ -77,6 +80,31 @@ const dev = citty.defineCommand({
 });
 
 const logger = consola.createConsola().withTag("arri");
+async function loadAppDefinition(input) {
+  const isUrl = input.startsWith("http://") || input.startsWith("https://");
+  if (isUrl) {
+    const result = await ofetch.ofetch(input);
+    if (!codegenUtils.isAppDefinition(result)) {
+      throw new Error(`Invalid App Definition at ${input}`);
+    }
+    return result;
+  }
+  if (!fs__default.existsSync(input)) {
+    throw new Error(`Unable to find ${input}`);
+  }
+  if (input.endsWith(".ts") || input.endsWith(".js")) {
+    const { config } = await c12.loadConfig({ configFile: input });
+    if (!codegenUtils.isAppDefinition(config)) {
+      throw new Error(`Invalid App Definition at ${input}`);
+    }
+    return config;
+  }
+  const parsed = JSON.parse(fs__default.readFileSync(input, "utf-8"));
+  if (!codegenUtils.isAppDefinition(parsed)) {
+    throw new Error(`Invalid App Definition at ${input}`);
+  }
+  return parsed;
+}
 function isInsideDir(dir, parentDir) {
   if (path__default.resolve(dir).startsWith(path__default.resolve(parentDir))) {
     return true;
@@ -173,4 +201,5 @@ exports.getArriPackageMetadata = getArriPackageMetadata;
 exports.isArriConfig = isArriConfig;
 exports.isInsideDir = isInsideDir;
 exports.isServerConfig = isServerConfig;
+exports.loadAppDefinition = loadAppDefinition;
 exports.logger = logger;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "arri",
-  "version": "0.81.1",
+  "version": "0.81.2",
   "type": "module",
   "license": "MIT",
   "author": {
@@ -39,13 +39,13 @@
     "ofetch": "^1.5.1",
     "pathe": "^2.0.3",
     "prettier": "^3.7.4",
-    "@arrirpc/codegen-dart": "0.81.1",
-    "@arrirpc/codegen-kotlin": "0.81.1",
-    "@arrirpc/codegen-rust": "0.81.1",
-    "@arrirpc/codegen-swift": "0.81.1",
-    "@arrirpc/codegen-utils": "0.81.1",
-    "@arrirpc/schema": "0.81.1",
-    "@arrirpc/codegen-ts": "0.81.1"
+    "@arrirpc/codegen-dart": "0.81.2",
+    "@arrirpc/codegen-kotlin": "0.81.2",
+    "@arrirpc/codegen-ts": "0.81.2",
+    "@arrirpc/codegen-rust": "0.81.2",
+    "@arrirpc/codegen-utils": "0.81.2",
+    "@arrirpc/schema": "0.81.2",
+    "@arrirpc/codegen-swift": "0.81.2"
   },
   "devDependencies": {
     "@types/degit": "^2.8.6"